codex-in-claude

Overview Schema Source Related Servers Discussions Admin

Cancel a job (free)

codex_job_cancel

Idempotent

Stops a running background Codex job by shutting down its worker gracefully, force-killing on timeout, and marking it cancelled; safe to retry since terminal jobs return unchanged.

Instructions

Deprecated: use amicus_job_cancel. Cancel a running background Codex job.

Asks the worker to shut down gracefully so it tears down its throwaway worktree, then force-kills it if it overstays, and marks the job cancelled (cancelled jobs cannot be resumed). If the worktree could not be removed, cleanup_warnings names the leftover path. Already-terminal jobs are returned unchanged, so cancel is idempotent — a retry after a lost response is safe. Free — no model call.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`job_id`	Yes	The job_id from an *_async call or a sync call's meta.job_id; recover lost ids with codex_job_list. Control characters are rejected, not stripped.
`workspace_root`	No	Absolute path to the target repo root — pass it (or an MCP root) to target the intended repo; otherwise the call falls back to the server's own cwd and sets meta.workspace_warning. On an active call it selects where Codex works, not what it can read — it is not a read boundary.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`ok`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.19.0Aug 22, 2026

changedInput schema / properties / job_id / description

Previous value: -"The job_id from an *_async call or a sync call's meta.job_id; recover lost ids with codex_job_list."New value: +"The job_id from an *_async call or a sync call's meta.job_id; recover lost ids with codex_job_list. Control characters are rejected, not stripped."

addedInput schema / properties / job_id / pattern
```
Added value: +"^[^\\x00-\\x1F\\x7F-\\x9F]*$"
```

changedInput schema / properties / workspace_root / description

Previous value: -"Absolute path to the target repo root — pass it (or an MCP root) to target the intended repo; otherwise the call falls back to the server's own cwd and sets meta.workspace_warning."New value: +"Absolute path to the target repo root — pass it (or an MCP root) to target the intended repo; otherwise the call falls back to the server's own cwd and sets meta.workspace_warning. On an active call it selects where Codex works, not what it can read — it is not a read boundary."

Changed2 schema fields changedv0.17.0Aug 3, 2026

changedInput schema / properties / workspace_root / description

Previous value: -"Absolute path to the target repository root. Pass it (or rely on an MCP root) so the call targets the intended repo; otherwise it falls back to the server's own cwd and meta.workspace_warning is set."New value: +"Absolute path to the target repo root — pass it (or an MCP root) to target the intended repo; otherwise the call falls back to the server's own cwd and sets meta.workspace_warning."

changedOutput schema / anyOf

Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "cleanup_warnings": {
-        "items": {
-          "type": "string"
-        },
-        "type": "array"
-      },
-      "deadline_seconds": {
-        "type": "integer"
-      },
-      "detail": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "elapsed_ms": {
-        "type": "integer"
-      },
-      "event_age_ms": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "events_seen": {
-        "type": "integer"
-      },
-      "expires_at": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "fingerprint": {
-        "type": "string"
-      },
-      "job_id": {
-        "type": "string"
-      },
-      "kind": {
-        "type": "string"
-      },
-      "last_event_at": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "ok": {
-        "const": true,
-        "type": "boolean"
-      },
-      "poll_after_ms": {
-        "type": "integer"
-      },
-      "result_available": {
-        "type": "boolean"
-      },
-      "server_version": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "started_at": {
-        "type": "string"
-      },
-      "status": {
-        "enum": [
-          "running",
-          "done",
-          "failed",
-          "cancelled",
-          "timeout"
-        ],
-        "type": "string"
-      },
-      "ttl_seconds": {
-        "type": "integer"
-      },
-      "workspace": {
-        "additionalProperties": false,
-        "properties": {
-          "cwd": {
-            "type": "string"
-          },
-          "workspace_source": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "workspace_warning": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          }
-        },
-        "required": [
-          "cwd"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "job_id",
-      "kind",
-      "status",
-      "started_at",
-      "elapsed_ms",
-      "deadline_seconds",
-      "ttl_seconds",
-      "workspace"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "error": {
-        "description": "Populated error envelope; full schema at resource codex://error-envelope",
-        "type": "object"
-      },
-      "meta": {
-        "type": "object"
-      },
-      "ok": {
-        "const": false
-      }
-    },
-    "required": [
-      "ok",
-      "error",
-      "meta"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "cleanup_warnings": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "deadline_seconds": {
+        "type": "integer"
+      },
+      "detail": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "elapsed_ms": {
+        "type": "integer"
+      },
+      "event_age_ms": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "events_seen": {
+        "type": "integer"
+      },
+      "expires_at": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fingerprint": {
+        "type": "string"
+      },
+      "job_id": {
+        "type": "string"
+      },
+      "kind": {
+        "type": "string"
+      },
+      "last_event_at": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "ok": {
+        "const": true,
+        "type": "boolean"
+      },
+      "poll_after_ms": {
+        "type": "integer"
+      },
+      "result_available": {
+        "type": "boolean"
+      },
+      "result_ok": {
+        "anyOf": [
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "server_version": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "started_at": {
+        "type": "string"
+      },
+      "status": {
+        "enum": [
+          "running",
+          "done",
+          "failed",
+          "cancelled",
+          "timeout"
+        ],
+        "type": "string"
+      },
+      "ttl_seconds": {
+        "type": "integer"
+      },
+      "workspace": {
+        "additionalProperties": false,
+        "properties": {
+          "cwd": {
+            "type": "string"
+          },
+          "workspace_source": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "workspace_warning": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "cwd"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "job_id",
+      "kind",
+      "status",
+      "started_at",
+      "elapsed_ms",
+      "deadline_seconds",
+      "ttl_seconds",
+      "result_ok",
+      "workspace"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "error": {
+        "description": "Populated error envelope; full schema at resource codex://error-envelope",
+        "type": "object"
+      },
+      "meta": {
+        "type": "object"
+      },
+      "ok": {
+        "const": false
+      }
+    },
+    "required": [
+      "ok",
+      "error",
+      "meta"
+    ],
+    "type": "object"
+  }
+]

Changed1 schema field changedv0.11.0Jul 14, 2026

changedOutput schema / anyOf

Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "cleanup_warnings": {
-        "items": {
-          "type": "string"
-        },
-        "type": "array"
-      },
-      "deadline_seconds": {
-        "type": "integer"
-      },
-      "detail": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "elapsed_ms": {
-        "type": "integer"
-      },
-      "event_age_ms": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "events_seen": {
-        "type": "integer"
-      },
-      "expires_at": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "fingerprint": {
-        "type": "string"
-      },
-      "job_id": {
-        "type": "string"
-      },
-      "kind": {
-        "type": "string"
-      },
-      "last_event_at": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "ok": {
-        "const": true,
-        "type": "boolean"
-      },
-      "poll_after_ms": {
-        "type": "integer"
-      },
-      "result_available": {
-        "type": "boolean"
-      },
-      "started_at": {
-        "type": "string"
-      },
-      "status": {
-        "enum": [
-          "running",
-          "done",
-          "failed",
-          "cancelled",
-          "timeout"
-        ],
-        "type": "string"
-      },
-      "ttl_seconds": {
-        "type": "integer"
-      },
-      "workspace": {
-        "additionalProperties": false,
-        "properties": {
-          "cwd": {
-            "type": "string"
-          },
-          "workspace_source": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "workspace_warning": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          }
-        },
-        "required": [
-          "cwd"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "job_id",
-      "kind",
-      "status",
-      "started_at",
-      "elapsed_ms",
-      "deadline_seconds",
-      "ttl_seconds",
-      "workspace"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "error": {
-        "description": "Populated error envelope; full schema at resource codex://error-envelope",
-        "type": "object"
-      },
-      "meta": {
-        "type": "object"
-      },
-      "ok": {
-        "const": false
-      }
-    },
-    "required": [
-      "ok",
-      "error",
-      "meta"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "cleanup_warnings": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "deadline_seconds": {
+        "type": "integer"
+      },
+      "detail": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "elapsed_ms": {
+        "type": "integer"
+      },
+      "event_age_ms": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "events_seen": {
+        "type": "integer"
+      },
+      "expires_at": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fingerprint": {
+        "type": "string"
+      },
+      "job_id": {
+        "type": "string"
+      },
+      "kind": {
+        "type": "string"
+      },
+      "last_event_at": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "ok": {
+        "const": true,
+        "type": "boolean"
+      },
+      "poll_after_ms": {
+        "type": "integer"
+      },
+      "result_available": {
+        "type": "boolean"
+      },
+      "server_version": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "started_at": {
+        "type": "string"
+      },
+      "status": {
+        "enum": [
+          "running",
+          "done",
+          "failed",
+          "cancelled",
+          "timeout"
+        ],
+        "type": "string"
+      },
+      "ttl_seconds": {
+        "type": "integer"
+      },
+      "workspace": {
+        "additionalProperties": false,
+        "properties": {
+          "cwd": {
+            "type": "string"
+          },
+          "workspace_source": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "workspace_warning": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "cwd"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "job_id",
+      "kind",
+      "status",
+      "started_at",
+      "elapsed_ms",
+      "deadline_seconds",
+      "ttl_seconds",
+      "workspace"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "error": {
+        "description": "Populated error envelope; full schema at resource codex://error-envelope",
+        "type": "object"
+      },
+      "meta": {
+        "type": "object"
+      },
+      "ok": {
+        "const": false
+      }
+    },
+    "required": [
+      "ok",
+      "error",
+      "meta"
+    ],
+    "type": "object"
+  }
+]

Changed2 schema fields changedv0.8.0Jul 6, 2026

changedInput schema / properties / job_id / description

Previous value: -"The job_id returned by an *_async call (codex_*_async); recover lost ids with codex_job_list."New value: +"The job_id from an *_async call or a sync call's meta.job_id; recover lost ids with codex_job_list."

addedOutput schema / $schema

Added value: +"https://json-schema.org/draft/2020-12/schema"

First observedv0.5.0Jun 28, 2026

TDQS

A4.4/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations: describes graceful shutdown then force-kill, that cancelled jobs cannot be resumed, that already-terminal jobs are returned unchanged, and that cleanup_warnings surfaces leftover worktree paths. None of that is derivable from idempotentHint/destructiveHint alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the deprecation notice, then the behavioral detail in a tight paragraph; every sentence carries information. Slightly long, but nothing reads as filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and the description still names the one noteworthy return artifact (cleanup_warnings). Mutation semantics, idempotency, and lifecycle effects are all covered, so an agent has everything needed to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already fully documents job_id and workspace_root, including fallback behavior and control-character rejection. The description adds no parameter-level detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Cancel a running background Codex job') and immediately flags deprecation in favor of amicus_job_cancel, which is the most decision-relevant fact for an agent. An agent can distinguish it from sibling status/result/list tools without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes to the replacement (amicus_job_cancel) and states the retry-safety condition ('a retry after a lost response is safe'), which is real usage guidance. It does not, however, say when cancelling is appropriate vs. letting a job run or how it relates to codex_job_status/job_result beyond idempotency.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server