wt-tools MCP 服务器
使用说明(简要概览,面向开发者与部署运维)
-
项目简介
- 该仓库实现了一个针对 Claude Code 等客户端的 MCP 服务器,用来暴露工作区(worktree)、Ralph 循环、团队状态等资源,以及执行并注册工具,供客户端查询与调用。核心通过 FastMCP 实现,服务器端负责暴露资源、执行工具、以及提供与 Prompts 相关的上下文能力。
-
主要功能点
- 资源暴露(Resources):提供工作区、Ralph 状态、团队状态等数据的读取入口,便于客户端获取实时或准实时信息。
- 工具注册与执行(Tools):实现若干工具函数,如 list_worktrees、get_ralph_status、get_worktree_tasks、get_team_status 等,供 MCP 客户端调用。
- 数据源与内存能力(Memory & Prompts):通过内存相关工具和潜在的内存/上下文能力接口,支持跨会话的上下文查询与记忆协作(与仓库中的其他组件联合使用)。
- 多协作协议支持:以 MCP 的框架进行组织,理论上可通过不同传输通道(如 stdio、SSE、WebSocket)与客户端通信。
- 插件化与扩展性:提供插件化的架构(Plugins/PluginRegistry),便于后续扩展工具、资源或提示模板。
-
安装步骤
- 先安装并准备运行环境(Python 3.x、必要的网络工具、以及 Claude Code/客户端依赖)。
- 确保 FastMCP 已可用并在环境中可用。
- 将 mcp-server/wt_mcp_server.py 设置为可执行(如有权限问题,使用 chmod +x)。
- 启动 MCP 服务器,确保服务器监听到客户端请求时能够正确返回 JSON-RPC 风格的响应。
-
服务器配置(JSON 配置示例,供 MCP 客户端连接时参考) 注:MCP 客户端无需改动服务器实现的具体行为,但需要一个配置来告诉客户端如何连接到 MCP 服务器。下列信息来自仓库中的服务器实现及常见的客户端连接方式。
配置示意(JSON,描述服务器端信息与客户端连接参数) { "server_name": "wt-tools", "command": "python3", "args": ["mcp-server/wt_mcp_server.py"], "transport": "stdio", "description": "wt-tools MCP 服务器,暴露资源、工具与上下文能力给 MCP 客户端" }
参数含义说明:
- server_name:MCP 服务器在客户端侧的标识名,仓库实现中设定为 wt-tools。
- command/args:客户端用来启动服务器进程的命令及其参数;示例中使用当前仓库的相对路径来定位脚本(mcp-server/wt_mcp_server.py),运行环境为 Python3。
- transport:服务器与客户端通信的传输通道,示例为 stdio;实际部署中也可考虑 SSE、WebSocket 等传输形式。
- description:简要说明,便于在客户端配置界面展示。
-
基本使用方法
- 启动服务器
- 直接在仓库根目录下运行 mcp-server/wt_mcp_server.py(需要 Python 解释器)。
- 服务器启动后,客户端可通过 JSON-RPC 调用服务器暴露的工具(如 list_worktrees、get_ralph_status 等),并通过服务器返回的 JSON-RPC 响应进行后续处理。
- 客户端交互要点
- 客户端通过 JSON-RPC 请求向服务器请求资源、执行工具、读取提示模板等。
- 服务器返回相应的 JSON-RPC 响应,或在通知模式下推送信息。
- 服务器扩展与集成
- 如需扩展资源、工具或提示模板,参考仓库中的 MCP 服务器实现、资源与工具定义装饰器,以及插件框架(PluginRegistry/Plugin)。
- 通过插件机制可引入新的资源、工具或数据源,便于定制化的后端服务。
- 启动服务器
-
运行与测试提示
- 确保 Python 环境与依赖就绪,必要时安装 fastmcp 等依赖。
- 运行后可通过 Claude Code 或其他支持 MCP 的客户端进行连接测试,调用暴露的工具与资源端点。
- 如需本地专用测试,请确保测试用的 Claude Code 客户端可以对接到该服务器的端口/通道。
-
注意点
- MCP 服务器接口、请求/响应格式需严格遵循 MCP 标准以实现互操作性。
- 本实现包含资源、工具、以及与 OpenSpec/Memory 等模块的集成点,具体行为可能在不同环境下需要微调。