这个项目是一个基于 Model Context Protocol (MCP) 的服务器,旨在将 OpenAI 的 Codex CLI 工具的能力桥接到任何支持 MCP 的 AI 助手或集成开发环境(IDE),例如 Claude Code 或 Cursor。它允许你的 AI 客户端通过标准化的协议,安全、高效地调用 Codex CLI 进行代码操作。

主要功能点:

  • 智能代码分析与编辑: 允许 AI 助手通过 '@' 文件引用分析大型代码库,解释代码、查找漏洞并建议修复。
  • 结构化代码修改 (Change Mode): 支持生成 OLD/NEW 格式的结构化代码补丁,简化代码重构、迁移等任务,并支持分块传输大修补。
  • 创意与头脑风暴: 提供多种头脑风暴框架(如 SCAMPER、设计思维)和领域上下文,帮助 AI 生成创新想法、分析可行性。
  • 沙盒与审批机制: 支持 Codex 的审批和沙盒模式,确保 AI 修改代码时的安全性和可控性。
  • 实时进度通知: 在长时间操作期间向客户端发送进度更新,提供更好的用户体验。

安装步骤:

在你的系统上安装以下先决条件:

  1. Node.js: 确保安装 Node.js (v18.0.0 或更高版本)。你可以从 Node.js 官网 下载安装。
  2. Codex CLI: 安装并配置 OpenAI 的 Codex CLI。请访问 openai/codex GitHub 仓库 获取安装和认证说明。

完成先决条件安装后,你可以通过以下任一方式设置 MCP 服务器:

  • 一键安装(推荐,适用于 Claude Code 等客户端):

    claude mcp add codex-cli -- npx -y @trishchuk/codex-mcp-tool

    这条命令会通过 'npx' 运行 '@trishchuk/codex-mcp-tool',并将其注册为名为 'codex-cli' 的 MCP 服务器。

  • 手动配置到 Claude Desktop: 编辑你的 Claude Desktop 配置文件 ('claude_desktop_config.json'),添加 'mcpServers' 部分。该文件通常位于:

    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
    • Linux: '~/.config/claude/claude_desktop_config.json'

    如果使用 'npx' 方式运行:

    "mcpServers": {
      "codex-cli": {
        "command": "npx",
        "args": ["-y", "@trishchuk/codex-mcp-tool"]
      }
    }

    如果你选择全局安装了 'codex-mcp-tool' (例如 'npm install -g @trishchuk/codex-mcp-tool'),可以使用以下配置:

    "mcpServers": {
      "codex-cli": {
        "command": "codex-mcp"
      }
    }

    配置完成后,请重启你的终端或 AI 客户端。

服务器配置 (MCP 客户端使用):

MCP 客户端通常需要配置 MCP 服务器的启动命令 (command) 及参数 (args) 才能与 MCP 服务器建立连接。以下是 'codex-mcp-tool' 作为 MCP 服务器的典型配置信息,供 MCP 客户端参考:

{
  "mcpServers": {
    "codex-cli": {
      "name": "Codex CLI MCP Server",
      "description": "通过 Model Context Protocol 连接 OpenAI Codex CLI,提供代码分析、重构和创意生成功能。",
      "command": "npx",
      "args": ["-y", "@trishchuk/codex-mcp-tool"],
      "capabilities": {
        "tools": true,
        "prompts": true,
        "notifications": true,
        "logging": true
      }
    }
  }
}
  • 'name': 服务器的显示名称,客户端可根据此名称识别服务。
  • 'description': 服务器的功能描述。
  • 'command': 启动 MCP 服务器的可执行文件或脚本路径。例如,使用 'npx' 运行 npm 包。
  • 'args': 传递给 'command' 的参数列表。
  • 'capabilities': 服务器声明支持的 MCP 功能,如工具调用、Prompt 模板、通知和日志。

基本使用方法:

安装并配置完成后,你可以在兼容的 MCP 客户端(如 Claude Code)中直接调用此服务器提供的功能。

  • 验证安装: 在 Claude Code 中输入 '/mcp',检查 'codex-cli' 是否已列出并处于活动状态。
  • 访问工具: 在 AI 客户端中,输入 '/codex-cli' 即可访问其提供的工具。
  • 使用 Codex 分析文件:
    • “使用 codex 解释 'index.html'”
    • “使用 codex 分析 '@src/main.ts' 并解释其作用”
    • “使用 codex 总结 '@.' 当前目录”
  • 提问和头脑风暴:
    • “使用 codex 解释 React 的最佳实践”
    • “使用 codex 头脑风暴 10 个应用程序创新功能,并进行可行性分析”
    • “使用 codex 进行头脑风暴:'如何提高代码审查流程',领域:'软件',方法:'scamper'”
  • 安全沙盒测试:
    • “使用 codex 创建并运行一个处理数据的 Python 脚本”
    • “要求 codex 安全测试 '@script.py' 并解释其作用”

信息

分类

开发者工具