---
title: "corecluster_capacity_check"
url: https://docs.corefinity.com/mcp/tools/corecluster_capacity_check
type: tool
last_updated: 2026-11-13
feature: upgrades
related:
  - https://docs.corefinity.com/api/reference/corecluster/check-cluster-capacity.md
  - https://docs.corefinity.com/guides/sites/size-and-capacity/upgrade-a-package.md
---
# corecluster_capacity_check

**Check CoreCluster capacity.** Whether a set of new sites and environments (and the removal of others) would fit a CoreCluster or a package, before anything is created. Nothing is reserved. Scope: read.

- Scope: `read`
- Runs as a task: no

## When to use it

Whether a set of new sites and environments (and the removal of others) would fit a CoreCluster or a package, before anything is created. Nothing is reserved.

Automatic upgrades: on a CoreCluster whose company turned them on, a create that would take the cluster past 90 % of its package first buys the smallest add-on raise that makes room (or, when add-ons cannot, the next package), within the company's monthly limit, and goes ahead. Each upgrade stays on the monthly bill until it is changed back. Over the limit it is refused with `capacity_blocked`, naming the limit. See corestack_company_auto_upgrades_get. For such a CoreCluster this check answers `grows: true` and a warning instead of a `capacity_blocked` entry (on its own package, not a `package` what-if).

## Inputs

- `cluster_id` (integer, ≥ 1): Your CoreCluster; leave out to check a package before a cluster exists.
- `sites` (array of objects, up to 50 items): New sites: {platform, tier} rows (at most 50 rows across sites and environments).
  - `platform` (string, up to 32 characters, required)
  - `tier` (string, up to 32 characters, required)
- `environments` (array of objects, up to 50 items): New environments: {platform, tier} rows.
  - `platform` (string, up to 32 characters, required)
  - `tier` (string, up to 32 characters, required)
- `remove` (array of integer, ≥ 1): Ids of sites on the cluster to leave out of the projection.
- `package` (string, up to 64 characters): A package key (corestack_packages_list): project onto this package instead.
- `region` (string, up to 16 characters): Without cluster_id only: the region the cluster would be in.

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "cluster_id": {
      "description": "Your CoreCluster; leave out to check a package before a cluster exists.",
      "minimum": 1,
      "type": "integer"
    },
    "environments": {
      "description": "New environments: {platform, tier} rows.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "platform": {
            "maxLength": 32,
            "type": "string"
          },
          "tier": {
            "maxLength": 32,
            "type": "string"
          }
        },
        "required": [
          "platform",
          "tier"
        ],
        "type": "object"
      },
      "maxItems": 50,
      "type": "array"
    },
    "package": {
      "description": "A package key (corestack_packages_list): project onto this package instead.",
      "maxLength": 64,
      "type": "string"
    },
    "region": {
      "description": "Without cluster_id only: the region the cluster would be in.",
      "maxLength": 16,
      "type": "string"
    },
    "remove": {
      "description": "Ids of sites on the cluster to leave out of the projection.",
      "items": {
        "minimum": 1,
        "type": "integer"
      },
      "type": "array"
    },
    "sites": {
      "description": "New sites: {platform, tier} rows (at most 50 rows across sites and environments).",
      "items": {
        "additionalProperties": false,
        "properties": {
          "platform": {
            "maxLength": 32,
            "type": "string"
          },
          "tier": {
            "maxLength": 32,
            "type": "string"
          }
        },
        "required": [
          "platform",
          "tier"
        ],
        "type": "object"
      },
      "maxItems": 50,
      "type": "array"
    }
  },
  "type": "object"
}
```

## Refusals

- The refusals every tool can answer: `invalid_arguments`, `tenant_mismatch`, `scope_required`, `pin_refused`, `rate_limited`, `temporarily_unavailable`, `internal_error` (corestack://guides/how-this-server-works).

## Example

```json
{
  "name": "corecluster_capacity_check",
  "arguments": {
    "cluster_id": 812,
    "sites": [
      {
        "platform": "wordpress",
        "tier": "M"
      }
    ]
  }
}
```

## Prompt

```text
Using the Corefinity MCP server, call corecluster_capacity_check with cluster_id 812, sites [{"platform":"wordpress","tier":"M"}]. (Check CoreCluster capacity.) Tell me what it returned.
```

## The same task elsewhere

- Endpoint: [POST /api/corestack/clusters/{cluster}/capacity/check](https://docs.corefinity.com/api/reference/corecluster/check-cluster-capacity.md)
- Guide: [Upgrade package](https://docs.corefinity.com/guides/sites/size-and-capacity/upgrade-a-package.md)
