generation_jobs_cancelRequest cancellation of the identified queued or running generation. Work already performed can consume credits; cancellation does not establish a refund.
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | Job ID returned by any generation_*_create tool. | |
| workspaceId | No | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| Name | Required | Description | Default |
|---|---|---|---|
| job | Yes |
Changes observed during successful MCP inspections.
Output schema / properties / job / properties / audio_recoveryAdded value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attempt": {
+ "maximum": 16,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "mode": {
+ "const": "saved_audio_only",
+ "type": "string"
+ }
+ },
+ "required": [
+ "attempt",
+ "mode"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+}Output schema / properties / job / properties / content_directionAdded value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "current": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "brandContentHash": {
+ "type": "string"
+ },
+ "brandRevision": {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "seriesContentHash": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "seriesRevision": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "brandRevision",
+ "brandContentHash",
+ "seriesRevision",
+ "seriesContentHash"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "snapshot": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "brand": {
+ "additionalProperties": false,
+ "properties": {
+ "contentHash": {
+ "type": "string"
+ },
+ "documentId": {
+ "anyOf": [
+ {
+ "format": "uuid",
+ "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "markdown": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "revision": {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "sources": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "maxLength": 240,
+ "type": "string"
+ },
+ "url": {
+ "format": "uri",
+ "maxLength": 2048,
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "title"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "sources",
+ "path",
+ "documentId",
+ "revision",
+ "markdown",
+ "contentHash"
+ ],
+ "type": "object"
+ },
+ "capturedAt": {
+ "type": "string"
+ },
+ "scope": {
+ "additionalProperties": false,
+ "properties": {
+ "kind": {
+ "enum": [
+ "brand",
+ "series"
+ ],
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "seriesId": {
+ "anyOf": [
+ {
+ "format": "uuid",
+ "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "kind",
+ "seriesId",
+ "name"
+ ],
+ "type": "object"
+ },
+ "series": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "contentHash": {
+ "type": "string"
+ },
+ "documentId": {
+ "anyOf": [
+ {
+ "format": "uuid",
+ "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|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "markdown": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "revision": {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "sources": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "maxLength": 240,
+ "type": "string"
+ },
+ "url": {
+ "format": "uri",
+ "maxLength": 2048,
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "title"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "sources",
+ "path",
+ "documentId",
+ "revision",
+ "markdown",
+ "contentHash"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "capturedAt",
+ "scope",
+ "brand",
+ "series"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "status": {
+ "enum": [
+ "current",
+ "changed",
+ "unavailable",
+ "unrecorded"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "snapshot",
+ "status",
+ "current"
+ ],
+ "type": "object"
+}Output schema / properties / job / properties / recoveryAdded value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "actions": {
+ "items": {
+ "enum": [
+ "review_prompt",
+ "choose_model",
+ "request_review"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "alternatives": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "acceptance": {
+ "const": "unverified",
+ "type": "string"
+ },
+ "aspectRatio": {
+ "type": "string"
+ },
+ "estimatedCredits": {
+ "type": "number"
+ },
+ "generateAudio": {
+ "type": "boolean"
+ },
+ "label": {
+ "type": "string"
+ },
+ "model": {
+ "type": "string"
+ },
+ "outputResolution": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "requiresAssembly": {
+ "type": "boolean"
+ },
+ "resolution": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "segments": {
+ "items": {
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "model",
+ "label",
+ "segments",
+ "estimatedCredits",
+ "resolution",
+ "outputResolution",
+ "aspectRatio",
+ "generateAudio",
+ "requiresAssembly",
+ "acceptance"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "credits": {
+ "additionalProperties": false,
+ "properties": {
+ "charged": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "net": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "refunded": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "status": {
+ "enum": [
+ "not_charged",
+ "charged",
+ "refunded",
+ "pending",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "charged",
+ "refunded",
+ "net"
+ ],
+ "type": "object"
+ },
+ "failure": {
+ "additionalProperties": false,
+ "properties": {
+ "category": {
+ "enum": [
+ "copyright",
+ "content_policy",
+ "reference",
+ "invalid_input",
+ "temporary",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "model": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "provider": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "retryable": {
+ "type": "boolean"
+ },
+ "stage": {
+ "enum": [
+ "input",
+ "output",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "category",
+ "message",
+ "stage",
+ "retryable",
+ "model",
+ "provider"
+ ],
+ "type": "object"
+ },
+ "history": {
+ "additionalProperties": false,
+ "properties": {
+ "authoredPrompt": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "enhancementApplied": {
+ "type": "boolean"
+ },
+ "originalRequest": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "previews": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "after": {
+ "type": "string"
+ },
+ "approach": {
+ "enum": [
+ "clarify",
+ "original_character"
+ ],
+ "type": "string"
+ },
+ "before": {
+ "type": "string"
+ },
+ "createdAt": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "before",
+ "after",
+ "approach",
+ "createdAt"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "previousJobId": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "providerRequests": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "provider",
+ "status"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "references": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "settings": {
+ "additionalProperties": {},
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "submittedPrompt": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "originalRequest",
+ "authoredPrompt",
+ "submittedPrompt",
+ "enhancementApplied",
+ "previousJobId",
+ "previews",
+ "settings",
+ "references",
+ "providerRequests"
+ ],
+ "type": "object"
+ },
+ "jobId": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "reviewUrl": {
+ "type": "string"
+ },
+ "runId": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "jobId",
+ "runId",
+ "failure",
+ "credits",
+ "history",
+ "alternatives",
+ "actions",
+ "reviewUrl"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+}Output schema / properties / job / requiredPrevious value: -[
- "job_id",
- "kind",
- "status",
- "progress"
-]New value: +[
+ "job_id",
+ "kind",
+ "status",
+ "progress",
+ "content_direction"
+]Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, but the description adds non-obvious billing behavior: already-performed work can consume credits and cancellation does not establish a refund. It stops short of saying whether the cancellation is immediate, guaranteed, or what happens to partial output.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences, front-loaded with the action and scope, followed by the consequential caveat. No filler and nothing that fails to earn its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With only two fully-documented params and an output schema covering return values, the description supplies the missing piece (cost/refund consequences) for a destructive, non-readOnly operation. Minor gaps remain around post-cancellation state and reversibility.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so jobId and workspaceId are already fully documented in the schema; the description adds no additional parameter meaning. Baseline 3 applies when the schema carries the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (cancel) and resource (generation job) and narrows the applicable scope to jobs that are 'queued or running', which distinguishes it from generation_jobs_get and the generation_*_create siblings without requiring the schema to be opened.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The scope qualifier 'queued or running' implies when the tool is valid, but there is no explicit when-not guidance and no named alternative (e.g. what to do for an already-completed job). Usage is inferable rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.