API & DEVELOPERS

MCP reference · v1

cancel_job

Cancel a saved job. Requires requester rights or a company-job cancellation grant.

Changes saved state Can replace or revoke state

Company permissions

Required scopes: orchesphere.read, orchesphere.jobs. Current identity, company and service/portal rights are checked for every call. Scopes do not create access.

Company owner, or non-viewer requester with provider read, or provider jobs_cancel_all. Applies to queued/retry_wait/running/blocked states; terminal jobs remain unchanged. Equivalent REST operation.

Input schema

FieldTypeRequiredDescription / bounds
workspaceIdstringYesAn assigned company workspace ID.
jobIdstringYes—
Complete MCP input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "An assigned company workspace ID."
    },
    "jobId": {
      "type": "string"
    }
  },
  "required": [
    "workspaceId",
    "jobId"
  ],
  "additionalProperties": false
}

Tool call

json
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "cancel_job",
    "arguments": {
      "workspaceId": "11111111-1111-4111-8111-111111111111",
      "jobId": "33333333-3333-4333-8333-333333333333"
    }
  }
}

POST to https://orchesphere.ai/mcp with a Bearer token approved for the MCP resource. Initialize the connection first. Examples use fictional identifiers.

Response handling

A successful tool result includes text content and structuredContent. Inspect isError before treating a tool result as successful. Authentication and scope failures may use HTTP 401/403 with WWW-Authenticate. This tool does not publish a separate MCP output schema; use its returned structure rather than assuming a provider business-record response.

All MCP tools · Errors and retry guidance