Climux MCP 服务器
- 项目简介
- Climux 作为一个面向 AI 编码代理的后端服务,通过实现 MCP(Model Context Protocol)服务器,向外部 MCP 客户端提供一致的上下文信息、工具执行能力和资源访问接口,便于把多种编码工具统一接入到一个系统中。
- 主要功能点
- MCP 服务端实现:实现 ListTools 与 CallTool 等 MCP 请求,按标准 JSON-RPC 进行请求处理与响应,支持工具注册、调用以及会话管理。
- 工具与能力暴露:定义并暴露 run_task、session_list、session_resume、session_send、get_status、worktree_create、worktree_list、get_session_stats 等工具,方便客户端调用。
- 会话与状态管理:通过内部会话存储、进程管理、日志记录等机制管理任务执行、状态更新、输出日志与统计数据。
- 数据持久化:使用 SQLite(sql.js)数据库持久化会话、日志、统计等信息,具备初始化、查询、更新和清理等能力。
- 模块化设计:Router、ProcessManager、Workspace、SessionStore 等模块化组件,便于扩展新的提供者和工具。
- 安装与运行步骤
- 安装与构建依赖后,通过 climux mcp serve 启动 MCP 服务器;启动后,MCP 客户端可通过配置连接到服务器并执行工具调用。
- 常见先决条件:确保已按项目说明配置并安装所需的 CLI 提供者(Claude Code、Codex、Gemini、OpenCode 等)。
- 服务器配置(MCP 客户端所需的配置示例,JSON 形式,字段含义在注释中说明)
{
"serverName": "climux-mcp-server",
"command": "node",
"args": ["dist/mcp/server.js"]
}
说明:
- serverName: MCP 服务器在客户端的标识名称,便于区分与管理。
- command: 启动服务器的命令。此处以 Node 直接运行编译输出为例。
- args: 运行服务器的参数列表,指向 MCP 服务器的主执行入口。 注:MCP 客户端需要仅了解 serverName、command、args 等连接信息,不需要实现服务器端逻辑细节。
- 基本使用方法
- 启动服务器:在支持的环境中执行 climux mcp serve 或等效的 Node 启动命令,服务器将对外暴露 MCP 工具。
- 客户端交互:通过 JSON-RPC 调用列表工具(ListTools)与调用工具(CallTool)来获取可用工具、执行任务、获取状态与结果。
- 会话与日志:服务器在执行过程中管理会话、记录日志、提供会话统计信息,便于后续分析与复现。
- 监控与扩展:服务器设计为可扩展的后端框架,未来可接入新的提供者、工具或资源,保持与 MCP 生态的兼容性。