codex-mcp-server 1.0.1

MCP server for Codex CLI with tmux persistence, git worktree isolation, and async dispatch.

codex-mcp-server

MCP server for Codex CLI — tmux persistence, git worktree isolation, async dispatch.

English | 简体中文

---

特性

• tmux 持久化 — 所有任务运行在 tmux session 中，网络断开、窗口关闭后任务继续执行
• git worktree 隔离 — full-access 模式自动创建独立 worktree，并行任务互不干扰
• 阻塞 + 异步双模式 — codex 同步等待结果，codex_dispatch 立即返回后台运行
• 多轮对话 (resume) — 通过 session_id 延续上一次 Codex 会话
• 文件系统持久化 — 任务元数据存储在 ~/.codexmcp/tasks/，服务重启后可恢复
• 工作区日志 — 自动在 <cwd>/.codex-tasks/ 创建 symlink，IDE 中直接查看日志

工具

工具	作用	适合场景
codex	阻塞执行，等待完成后返回结果	代码审阅、短任务、并行模块实现
codex_dispatch	后台分派，立即返回 task_id	长任务（数十分钟到数小时）
codex_status	查询任务状态和进度	追踪后台任务、获取结果
codex_cancel	取消运行中的任务	终止不需要的任务

---

前置要求

• Python 3.12+
• codex CLI 已安装且在 PATH 中
• tmux 已安装（所有模式必须）
• git 已安装（full-access 模式必须）

codex --version
tmux -V
git --version

---

安装

从 PyPI 安装：

pip install codex-mcp-server

Claude Code

claude mcp add codex -s user --transport stdio -- \
  uvx --index-url https://pypi.org/simple/ codex-mcp-server

验证：

claude mcp list

Cursor / 通用 MCP 客户端

在 MCP 配置文件（如 mcp.json）中添加：

{
  "codex": {
    "command": "uvx",
    "args": [
      "--index-url", "https://pypi.org/simple/",
      "codex-mcp-server"
    ]
  }
}

更新

uvx --refresh --index-url https://pypi.org/simple/ codex-mcp-server --help

从源码安装（开发用）

git clone https://github.com/GuDaStudio/codexmcp.git
cd codexmcp
pip install -e .

---

快速上手

1. 代码审阅（阻塞，只读）

{
  "tool": "codex",
  "arguments": {
    "prompt": "审阅 src/auth/ 目录的代码质量和安全性",
    "cwd": "/workspace/my-project",
    "topic": "review-auth",
    "sandbox": "read-only"
  }
}

2. 并行模块实现（阻塞，写入）

并发调用多个 codex，每个使用不同 topic：

{
  "tool": "codex",
  "arguments": {
    "prompt": "实现用户注册模块...",
    "cwd": "/workspace/my-project",
    "topic": "impl-register",
    "sandbox": "full-access"
  }
}

每个 full-access 任务自动创建独立的 git worktree 和分支 agent/<topic>。

3. 长任务后台分派

{
  "tool": "codex_dispatch",
  "arguments": {
    "prompt": "重构整个项目为异步架构...",
    "cwd": "/workspace/my-project",
    "topic": "refactor-async",
    "sandbox": "full-access"
  }
}

立即返回 task_id。之后用 codex_status 查看进度。

4. Resume 多轮对话

首次执行返回 session_id。修改代码后继续：

{
  "tool": "codex",
  "arguments": {
    "prompt": "我已修改了代码，请重新审阅",
    "cwd": "/workspace/my-project",
    "topic": "review-auth-r2",
    "sandbox": "read-only",
    "session_id": "thread_abc123"
  }
}

---

参数说明

参数	类型	必填	说明
prompt	str	是	任务指令
cwd	Path	是	工作目录（绝对路径）
topic	str	是	任务标识。用于 tmux session 名、worktree 分支名、task_id
sandbox	read-only / full-access	是	权限模式。read-only 不建 worktree；full-access 创建 worktree 隔离
session_id	str	否	恢复之前的 Codex 会话（多轮对话）

返回结构

阻塞 codex 完成后返回：

{
  "success": true,
  "task_id": "codex-impl-feature",
  "session_id": "thread_abc123",
  "result": "Codex 的最终回复文本",
  "exit_code": 0,
  "elapsed_seconds": 45.2,
  "usage": {"input_tokens": 5000, "output_tokens": 1200},
  "worktree_dir": "/workspace/project-agent-impl-feature",
  "agent_branch": "agent/impl-feature",
  "base_branch": "main",
  "diff_stat": "3 files changed, 42 insertions(+), 10 deletions(-)",
  "commits_ahead": 2
}

• session_id 用于 resume
• worktree 相关字段仅 full-access 模式返回

---

环境变量

通过 MCP 服务进程环境变量配置：

变量	说明	示例
CODEX_PROFILE	codex 配置文件名	fast
CODEX_REASONING_EFFORT	推理强度	high、xhigh

---

日志

位置	路径
工作区 symlink	<cwd>/.codex-tasks/<topic>/codex-exec.log
主存储	~/.codexmcp/tasks/<task_id>/codex-exec.log
实时查看	tmux attach -t codex-<topic>

---

开发

git clone https://github.com/GuDaStudio/codexmcp.git
cd codexmcp
pip install -e .

---

许可证

MIT License