Codex MCP 服务器端

使用说明（Markdown 格式）

• 项目简介
  • 该仓库实现了一个 MCP 服务器，负责暴露资源、工具和提示模板等能力，供基于 MCP 的语言模型客户端通过 JSON-RPC 进行读取资源、执行工具、获取和渲染提示等操作。
• 主要功能点
  • 通过 MCP 服务器处理工具（Tools）与提示（Prompts）的注册、查询和执行请求。
  • 支持对工具执行的进度通知（progress notifications），并在执行过程中向客户端持续推送更新。
  • 提供对 Prompts 的列表和获取能力，帮助客户端进行对话模板的渲染。
  • 具备日志和错误处理能力，提供诊断信息，确保稳定运行。
  • 使用 Stdio 传输作为默认传输通道（也具备后续扩展为 SSE/WebSocket 等传输通道的潜在能力）。
• 安装步骤
  • 安装依赖并构建：在本地安装 Node.js 环境后，克隆仓库并安装依赖，随后执行构建步骤以生成可执行的服务入口（具体构建命令视项目配置而定）。
  • 运行服务：启动生成的入口脚本（例如 dist/index.js 或等效入口），服务器将监听并通过标准输入输出进行 MCP 通信。
• 服务器配置（MCP 客户端需要的配置信息，JSON 格式） 服务器名称与代码中定义的一致，启动命令及参数示例如下（以 JSON 形式给出，便于 MCP 客户端读取配置）： { "serverName": "codex-cli-mcp", "command": "node", "args": ["dist/index.js"] } 注释（非代码块描述）：serverName 与代码中 Server 实例的 name 字段一致，启动入口 dist/index.js 是编译产物的常见路径；若你的构建输出路径不同，请将 dist/index.js 替换为实际入口路径。MCP 客户端不需要包含该配置的额外实现，只需读取上述字段并使用指定命令启动服务器即可。
• 基本使用方法
  • 客户端启动：按照 MCP 客户端的标准流程，通过读取上述 JSON 配置启动与 MCP 服务器的会话。
  • 请求类型：可以读取资源、列出/获取工具、列出/获取提示、以及通过工具执行请求等，通过 JSON-RPC 协议进行通信。
  • 进度通知：若客户端在请求中指定了 progress 的需求，服务器将周期性推送进度更新，帮助跟踪长时间任务的执行进度。