guides/agents-sdk.md +3 −3
2 2
3# Running Codex as an MCP server3# Running Codex as an MCP server
4 4
55You can run Codex as an MCP server and connect it from other MCP clients (for example, an agent built with the [OpenAI Agents SDK](https://openai.github.io/openai-agents-js/guides/mcp/)).You can run Codex as an MCP server and connect it from other MCP clients (for example, an agent built with the [OpenAI Agents SDK MCP integration](https://developers.openai.com/api/docs/guides/agents/integrations-observability#mcp)).
6 6
7To start Codex as an MCP server, you can use the following command:7To start Codex as an MCP server, you can use the following command:
8 8
21**`codex`**: Run a Codex session. Accepts configuration parameters that match the Codex `Config` struct. The `codex` tool takes these properties:21**`codex`**: Run a Codex session. Accepts configuration parameters that match the Codex `Config` struct. The `codex` tool takes these properties:
22 22
23| Property | Type | Description |23| Property | Type | Description |
2424| --- | --- | --- || ----------------------- | --------- | -------------------------------------------------------------------------------------------------------- |
25| **`prompt`** (required) | `string` | The initial user prompt to start the Codex conversation. |25| **`prompt`** (required) | `string` | The initial user prompt to start the Codex conversation. |
26| `approval-policy` | `string` | Approval policy for shell commands generated by the model: `untrusted`, `on-request`, and `never`. |26| `approval-policy` | `string` | Approval policy for shell commands generated by the model: `untrusted`, `on-request`, and `never`. |
27| `base-instructions` | `string` | The set of instructions to use instead of the default ones. |27| `base-instructions` | `string` | The set of instructions to use instead of the default ones. |
35**`codex-reply`**: Continue a Codex session by providing the thread ID and prompt. The `codex-reply` tool takes these properties:35**`codex-reply`**: Continue a Codex session by providing the thread ID and prompt. The `codex-reply` tool takes these properties:
36 36
37| Property | Type | Description |37| Property | Type | Description |
3838| --- | --- | --- || ----------------------------- | ------ | --------------------------------------------------------- |
39| **`prompt`** (required) | string | The next user prompt to continue the Codex conversation. |39| **`prompt`** (required) | string | The next user prompt to continue the Codex conversation. |
40| **`threadId`** (required) | string | The ID of the thread to continue. |40| **`threadId`** (required) | string | The ID of the thread to continue. |
41| `conversationId` (deprecated) | string | Deprecated alias for `threadId` (kept for compatibility). |41| `conversationId` (deprecated) | string | Deprecated alias for `threadId` (kept for compatibility). |