rules.suspend

Live

Suspend an active Cortex rule.

CategoryRules
JSON-RPCtools/call
EndpointPOST /mcp
Sourcepackages/mcp-tools/src/tools/rules-suspend.ts

Description

Moves a rule from `active` to `suspended`. Suspended rules are preserved with full provenance and can be reactivated through the operator dashboard.

Input schema

FieldTypeRequiredDescription
rule_idstringyesRule ID to suspend.
reasonstringnoOptional suspension reason.

Output shape

typescript
{
  ok: boolean;
  error?: string;
}

Example call

JSON-RPC tools/call request body (omit the JSON-RPC envelope when using an SDK; the SDK adds it for you):

jsontools/call params
{
  "name": "rules.suspend",
  "arguments": {
    "rule_id": "rule_01HXP",
    "reason": "Conflicts with new schedule"
  }
}

Example response

Tool results are always wrapped as content[0].text with a stringified JSON body. The shape below is what you get back from JSON.parse(result.content[0].text):

jsonparsed result body
{ "ok": true }

Errors this tool can return

CodeMeaning
invalid_argumentsTool input failed Zod validation.
unauthorizedMissing or invalid bearer token.

See the full error catalog for resolution steps on each code, plus the standard transport-layer responses (401, 429).