# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## prepare_confirmation

Build a bounded preview of a mutation and return a confirmation token bound to the exact input.

Use before any capability whose confirmation policy is preview_token; the returned token is required to commit.

A preview executes nothing; do not treat it as a substitute for the commit call.

Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks.

Scopes: agent:capabilities

Risk: write; confirmation: preview_token; idempotency: supported.

### Input schema (personal API key)

```json
{
  "type": "object",
  "properties": {
    "capabilityId": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{0,63}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "input": {
      "$ref": "#/$defs/Union_"
    }
  },
  "required": [
    "capabilityId",
    "workspaceId",
    "input"
  ],
  "patternProperties": {
    "^(?!(?:capabilityId|workspaceId|input)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "capabilityId",
      "workspaceId",
      "input"
    ]
  },
  "$defs": {
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    }
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "capabilityId": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{0,63}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "input": {
      "$ref": "#/$defs/Union_"
    }
  },
  "required": [
    "capabilityId",
    "workspaceId",
    "input"
  ],
  "patternProperties": {
    "^(?!(?:capabilityId|workspaceId|input)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "capabilityId",
      "workspaceId",
      "input"
    ]
  },
  "$defs": {
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    }
  }
}
```

### Output schema (structuredContent)

```json
{
  "type": "object",
  "properties": {
    "preview": {
      "type": "object",
      "properties": {
        "summary": {
          "$ref": "#/$defs/Description"
        },
        "affected": {
          "type": "object",
          "properties": {
            "resourceCounts": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "$ref": "#/$defs/NonEmptyString"
                  },
                  "count": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "type",
                  "count"
                ],
                "patternProperties": {
                  "^(?!(?:type|count)$)[\\s\\S]*$": false
                },
                "additionalProperties": true,
                "propertyNames": {
                  "type": "string",
                  "enum": [
                    "type",
                    "count"
                  ]
                }
              },
              "maxItems": 64
            },
            "resourceIds": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/OpaqueId"
              },
              "maxItems": 256
            }
          },
          "required": [
            "resourceCounts",
            "resourceIds"
          ],
          "patternProperties": {
            "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "resourceCounts",
              "resourceIds"
            ]
          }
        },
        "costEstimate": {
          "type": "object",
          "properties": {
            "min": {
              "$ref": "#/$defs/Money"
            },
            "max": {
              "$ref": "#/$defs/Money"
            }
          },
          "required": [
            "min",
            "max"
          ],
          "patternProperties": {
            "^(?!(?:min|max)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "min",
              "max"
            ]
          }
        },
        "warnings": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ShortText"
          },
          "maxItems": 32
        },
        "irreversibleFacts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ShortText"
          },
          "maxItems": 32
        },
        "inputHash": {
          "$ref": "#/$defs/OpaqueId"
        },
        "previewVersion": {
          "$ref": "#/$defs/NonEmptyString"
        },
        "expiresAt": {
          "$ref": "#/$defs/UtcDateTimeEncoded"
        }
      },
      "required": [
        "summary",
        "affected",
        "warnings",
        "irreversibleFacts",
        "inputHash",
        "previewVersion",
        "expiresAt"
      ],
      "patternProperties": {
        "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "summary",
          "affected",
          "costEstimate",
          "warnings",
          "irreversibleFacts",
          "inputHash",
          "previewVersion",
          "expiresAt"
        ]
      }
    },
    "confirmationToken": {
      "$ref": "#/$defs/OpaqueId"
    }
  },
  "required": [
    "preview",
    "confirmationToken"
  ],
  "patternProperties": {
    "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "preview",
      "confirmationToken"
    ]
  },
  "$defs": {
    "Description": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "NonEmptyString": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "OpaqueId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "Money": {
      "type": "object",
      "properties": {
        "amountMinor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "currency": {
          "type": "string",
          "enum": [
            "AED",
            "AFN",
            "ALL",
            "AMD",
            "AOA",
            "ARS",
            "AUD",
            "AWG",
            "AZN",
            "BAM",
            "BBD",
            "BDT",
            "BHD",
            "BIF",
            "BMD",
            "BND",
            "BOB",
            "BOV",
            "BRL",
            "BSD",
            "BTN",
            "BWP",
            "BYN",
            "BZD",
            "CAD",
            "CDF",
            "CHE",
            "CHF",
            "CHW",
            "CLF",
            "CLP",
            "CNY",
            "COP",
            "COU",
            "CRC",
            "CUP",
            "CVE",
            "CZK",
            "DJF",
            "DKK",
            "DOP",
            "DZD",
            "EGP",
            "ERN",
            "ETB",
            "EUR",
            "FJD",
            "FKP",
            "GBP",
            "GEL",
            "GHS",
            "GIP",
            "GMD",
            "GNF",
            "GTQ",
            "GYD",
            "HKD",
            "HNL",
            "HTG",
            "HUF",
            "IDR",
            "ILS",
            "INR",
            "IQD",
            "IRR",
            "ISK",
            "JMD",
            "JOD",
            "JPY",
            "KES",
            "KGS",
            "KHR",
            "KMF",
            "KPW",
            "KRW",
            "KWD",
            "KYD",
            "KZT",
            "LAK",
            "LBP",
            "LKR",
            "LRD",
            "LSL",
            "LYD",
            "MAD",
            "MDL",
            "MGA",
            "MKD",
            "MMK",
            "MNT",
            "MOP",
            "MRU",
            "MUR",
            "MVR",
            "MWK",
            "MXN",
            "MXV",
            "MYR",
            "MZN",
            "NAD",
            "NGN",
            "NIO",
            "NOK",
            "NPR",
            "NZD",
            "OMR",
            "PAB",
            "PEN",
            "PGK",
            "PHP",
            "PKR",
            "PLN",
            "PYG",
            "QAR",
            "RON",
            "RSD",
            "RUB",
            "RWF",
            "SAR",
            "SBD",
            "SCR",
            "SDG",
            "SEK",
            "SGD",
            "SHP",
            "SLE",
            "SOS",
            "SRD",
            "SSP",
            "STN",
            "SVC",
            "SYP",
            "SZL",
            "THB",
            "TJS",
            "TMT",
            "TND",
            "TOP",
            "TRY",
            "TTD",
            "TWD",
            "TZS",
            "UAH",
            "UGX",
            "USD",
            "USN",
            "UYI",
            "UYU",
            "UYW",
            "UZS",
            "VED",
            "VES",
            "VND",
            "VUV",
            "WST",
            "XAD",
            "XAF",
            "XAG",
            "XAU",
            "XBA",
            "XBB",
            "XBC",
            "XBD",
            "XCD",
            "XCG",
            "XDR",
            "XOF",
            "XPD",
            "XPF",
            "XPT",
            "XSU",
            "XTS",
            "XUA",
            "XXX",
            "YER",
            "ZAR",
            "ZMW",
            "ZWG"
          ]
        }
      },
      "required": [
        "amountMinor",
        "currency"
      ],
      "patternProperties": {
        "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "amountMinor",
          "currency"
        ]
      }
    },
    "ShortText": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    }
  }
}
```

### Underlying API operations

- `agent.prepareConfirmation`: `POST /agent/confirmations`

