codex-mcp-agent


Namecodex-mcp-agent JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryMCP server that provides agent capability backing by codex CLI
upload_time2025-08-23 12:42:35
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords agent codex mcp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # codex-mcp-agent

[中文版](./README.zh-CN.md)

Note: This project is a fork of the current Git remote:

- origin: https://github.com/1WorldCapture/codex-as-mcp

Enable Claude Code, Cursor and other AI tools to call Codex for task execution. Plus/Pro/Team subscribers can maximize GPT-5 usage without additional costs.

## Setup

### 1. Install Codex CLI
```bash
npm install -g @openai/codex
codex login
```

### 2. Configure MCP

Add to your `.mcp.json`:
**Safe Mode (Default):**
```json
{
  "mcpServers": {
    "codex": {
      "type": "stdio",
      "command": "uvx",
      "args": ["codex-mcp-agent@latest"]
    }
  }
}
```

**Writable Mode:**
```json
{
  "mcpServers": {
    "codex": {
      "type": "stdio",
      "command": "uvx",
      "args": ["codex-mcp-agent@latest", "--yolo"]
    }
  }
}
```

Or use Claude Code commands:
```bash
# Safe mode (default)
claude mcp add codex-mcp-agent -- uvx codex-mcp-agent@latest

# Writable mode
claude mcp add codex-mcp-agent -- uvx codex-mcp-agent@latest --yolo
```

## Tools

The MCP server exposes two tools:
- `codex_execute(prompt, work_dir)` - General purpose codex execution
- `codex_review(review_type, work_dir, target?, prompt?)` - Specialized code review

If you have any other use case requirements, feel free to open issue.

## HTTP/SSE Mode (Optional)

For local personal use, you can run the server over HTTP with Server-Sent Events (SSE) and connect via `type: "sse"`.

Start the server in SSE mode:
```bash
uvx codex-mcp-agent@latest --sse            # safe mode, localhost:8822
uvx codex-mcp-agent@latest --sse --yolo     # writable mode

# Options
#   --host  (default: 127.0.0.1)
#   --port  (default: 8822)
```

Configure your client `.mcp.json`:
```json
{
  "mcpServers": {
    "codex": {
      "type": "sse",
      "url": "http://127.0.0.1:8822"
    }
  }
}
```

Notes:
- SSE mode keeps the same Safe/Writable behavior controlled by `--yolo`.
- SSE server binds to `127.0.0.1` by default and has no auth/CORS for simplicity.
- Stdio mode remains the default; use `--sse` only if you prefer HTTP.

Optional: Streamable HTTP transport (if your client supports it):
```bash
uvx codex-mcp-agent@latest --http           # safe mode streamable-http transport
```

## Safety

- **Safe Mode**: Default read-only operations protect your environment
- **Writable Mode**: Use `--yolo` flag when you need full codex capabilities
- **Sequential Execution**: Prevents conflicts from parallel agent operations

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "codex-mcp-agent",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "agent, codex, mcp",
    "author": null,
    "author_email": "Lyon Liang <lyon.liang12@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e4/4b/262c04331abcc63901a80e4cfaf41dcf6d1fd029e79649725353b9dbd3f0/codex_mcp_agent-0.1.0.tar.gz",
    "platform": null,
    "description": "# codex-mcp-agent\n\n[\u4e2d\u6587\u7248](./README.zh-CN.md)\n\nNote: This project is a fork of the current Git remote:\n\n- origin: https://github.com/1WorldCapture/codex-as-mcp\n\nEnable Claude Code, Cursor and other AI tools to call Codex for task execution. Plus/Pro/Team subscribers can maximize GPT-5 usage without additional costs.\n\n## Setup\n\n### 1. Install Codex CLI\n```bash\nnpm install -g @openai/codex\ncodex login\n```\n\n### 2. Configure MCP\n\nAdd to your `.mcp.json`:\n**Safe Mode (Default):**\n```json\n{\n  \"mcpServers\": {\n    \"codex\": {\n      \"type\": \"stdio\",\n      \"command\": \"uvx\",\n      \"args\": [\"codex-mcp-agent@latest\"]\n    }\n  }\n}\n```\n\n**Writable Mode:**\n```json\n{\n  \"mcpServers\": {\n    \"codex\": {\n      \"type\": \"stdio\",\n      \"command\": \"uvx\",\n      \"args\": [\"codex-mcp-agent@latest\", \"--yolo\"]\n    }\n  }\n}\n```\n\nOr use Claude Code commands:\n```bash\n# Safe mode (default)\nclaude mcp add codex-mcp-agent -- uvx codex-mcp-agent@latest\n\n# Writable mode\nclaude mcp add codex-mcp-agent -- uvx codex-mcp-agent@latest --yolo\n```\n\n## Tools\n\nThe MCP server exposes two tools:\n- `codex_execute(prompt, work_dir)` - General purpose codex execution\n- `codex_review(review_type, work_dir, target?, prompt?)` - Specialized code review\n\nIf you have any other use case requirements, feel free to open issue.\n\n## HTTP/SSE Mode (Optional)\n\nFor local personal use, you can run the server over HTTP with Server-Sent Events (SSE) and connect via `type: \"sse\"`.\n\nStart the server in SSE mode:\n```bash\nuvx codex-mcp-agent@latest --sse            # safe mode, localhost:8822\nuvx codex-mcp-agent@latest --sse --yolo     # writable mode\n\n# Options\n#   --host  (default: 127.0.0.1)\n#   --port  (default: 8822)\n```\n\nConfigure your client `.mcp.json`:\n```json\n{\n  \"mcpServers\": {\n    \"codex\": {\n      \"type\": \"sse\",\n      \"url\": \"http://127.0.0.1:8822\"\n    }\n  }\n}\n```\n\nNotes:\n- SSE mode keeps the same Safe/Writable behavior controlled by `--yolo`.\n- SSE server binds to `127.0.0.1` by default and has no auth/CORS for simplicity.\n- Stdio mode remains the default; use `--sse` only if you prefer HTTP.\n\nOptional: Streamable HTTP transport (if your client supports it):\n```bash\nuvx codex-mcp-agent@latest --http           # safe mode streamable-http transport\n```\n\n## Safety\n\n- **Safe Mode**: Default read-only operations protect your environment\n- **Writable Mode**: Use `--yolo` flag when you need full codex capabilities\n- **Sequential Execution**: Prevents conflicts from parallel agent operations\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "MCP server that provides agent capability backing by codex CLI",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/1WorldCapture/codex-as-mcp",
        "Issues": "https://github.com/1WorldCapture/codex-as-mcp/issues",
        "Repository": "https://github.com/1WorldCapture/codex-as-mcp"
    },
    "split_keywords": [
        "agent",
        " codex",
        " mcp"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8f75f8aea1e40179c7bc673bb1fb27dd6efc44fa2bae4a90767eafbd312b125d",
                "md5": "46d8e52d0503041a21fd157d9ea93c4b",
                "sha256": "96013faea383a084fe7a25ad272583df8297b946573483fee5652a3cef58ea52"
            },
            "downloads": -1,
            "filename": "codex_mcp_agent-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "46d8e52d0503041a21fd157d9ea93c4b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 10960,
            "upload_time": "2025-08-23T12:42:33",
            "upload_time_iso_8601": "2025-08-23T12:42:33.691682Z",
            "url": "https://files.pythonhosted.org/packages/8f/75/f8aea1e40179c7bc673bb1fb27dd6efc44fa2bae4a90767eafbd312b125d/codex_mcp_agent-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e44b262c04331abcc63901a80e4cfaf41dcf6d1fd029e79649725353b9dbd3f0",
                "md5": "8cb0df28ffe7c7e0df04a704b4415be9",
                "sha256": "e5c514c65a622fb3de3751c3c271cbc9a4dee1c8b199362e7546098992f22683"
            },
            "downloads": -1,
            "filename": "codex_mcp_agent-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8cb0df28ffe7c7e0df04a704b4415be9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 51125,
            "upload_time": "2025-08-23T12:42:35",
            "upload_time_iso_8601": "2025-08-23T12:42:35.742198Z",
            "url": "https://files.pythonhosted.org/packages/e4/4b/262c04331abcc63901a80e4cfaf41dcf6d1fd029e79649725353b9dbd3f0/codex_mcp_agent-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-23 12:42:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "1WorldCapture",
    "github_project": "codex-as-mcp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "codex-mcp-agent"
}
        
Elapsed time: 0.47780s