Grimoire Kit BMAD MCP 服务器
使用说明
- 项目简介
- 该项目在 Grimoire Kit 框架中实现了一个 MCP 服务器,用于 BMAD Intelligence Layer 的后端服务。通过 MCP 标准,LLM 客户端(如 Cursor、Claude Desktop、Cline 等)可以以统一的 JSON-RPC 调用格式访问 BMAD 的工具集、资源与提示模板,获得上下文与外部功能能力。
- 主要功能点
- 暴露 BMAD Intelligence Layer 的工具集:包含 8 个 Legacy 工具以及可自动发现的 Synapse/BMAD 相关工具,统一通过 MCP 服务器暴露给客户端。
- 工具注册与执行:提供 list_tools、call_tool 等接口,支持工具名称、输入结构、返回结构(JSON)等规范化描述。
- 自动发现能力(Auto-Discovery):对 framework/tools 下的新工具进行动态发现并暴露,减少手动注册的工作量。
- 资源与上下文能力:通过工具集实现对项目上下文、记忆、工作流、RAG、记忆与对外任务的调用和管理,确保 LLM 客户端可以获取资源上下文。
- 安全性与审计:内置对请求的基本处理流程、速率限制、输入 sanitization(在工具实现中体现,例如 MCP 工具分发点对输入进行清洗和审计钩子),避免注入和滥用,提供审计日志。
- 兼容性与扩展性:MCP Server 设计兼容 Cursor/Claude Desktop/Cline 这类 IDE 提供的 MCP 接入方式,且具备扩展性以支撑更多 BMAD 场景的工具。
- 安装步骤
- 环境要求:Python 3.12+;可选依赖(如需要额外的 MCP 客户端功能)可通过 pip install mcp 安装(及可选的 "mcp[cli]")。
- 获取代码:确保你已经获取 Grimoire Kit 仓库中的 bmAD MCP 服务器脚本,核心入口位于 framework/tools/bmad-mcp-tools.py。
- 启动服务器:在你的项目根目录执行,确保 BMAD_PROJECT_ROOT 指向你的项目根路径。示例命令如下(请替换为实际路径):
- python3 /path/to/grimoire-kit/framework/tools/bmad-mcp-tools.py
- MCP 客户端配置(由 IDE 侧提供,不强依赖你本地环境)请参考下方的服务器配置示例。服务器运行后,MCP 客户端即可通过 JSON-RPC 与其交互。
- 服务器配置(MCP 客户端需要的最小启动信息,示例为 JSON 配置)
- server 名称:bmad-intelligence
- command:python3
- args:列表,包含启动服务器脚本的路径
- env:可选环境变量,常用 BMAD_PROJECT_ROOT 指向你的 BMAD 项目根
- 说明:MCP 客户端需要的配置通常以此结构被 IDE 读取,用于启动并连接到 MCP 服务器。下面给出一个准确反映仓库信息的配置示例(请用实际路径替换占位符):
- 服务器配置示例(JSON) { "servers": { "bmad-intelligence": { "command": "python3", "args": ["/path/to/grimoire-kit/framework/tools/bmad-mcp-tools.py"], "env": { "BMAD_PROJECT_ROOT": "/path/to/your/project" } } } }
- 说明(字段含义)
- servers: MCP 服务器集合
- bmad-intelligence: 服务器名称,与服务器端初始化的一致
- command: 启动服务器的命令
- args: 启动命令的参数,必须包含启动 BMAD MCP 服务的脚本路径
- env: 环境变量配置,其中 BMAD_PROJECT_ROOT 指向 BMAD 项目根目录
- 基本使用方法
- 启动 MCP 服务器:在项目根环境中执行提供的启动命令(如上所述的 python3 指令),服务器启动后会与 MCP 客户端建立连接。
- 客户端交互:使用 MCP 客户端(如 Claude Desktop、Cursor、Cline 等)通过 JSON-RPC 调用服务器暴露的工具、路由、资源等接口,获取工具列表、执行工具、获取工作流状态、查询内存、读取资源等能力。
- 运行与扩展:服务器支持对 framework/tools 下新增工具自动发现,确保新工具可在 MCP 客户端无缝使用。若需要自定义工具暴露方式,可在 bmAD 代码中扩展新的工具处理逻辑。