Codebeamer MCP 是一个基于模型上下文协议(Model Context Protocol,MCP)的服务器,用于连接 Codebeamer ALM 系统。其主要用途是让 Claude 及其他兼容 MCP 的客户端能够通过自然语言与 Codebeamer 进行交互,实现对项目、跟踪器和工作项等数据的读取与写入。
主要能力
- 读取和写入 Codebeamer 中的项目、跟踪器和工作项。
- 操作关联、引用、评论以及风险管理数据。
- 通过 REST API 与 Codebeamer 实例通信。
使用方式
使用前需要准备好 Codebeamer 实例的访问信息,包括 URL、用户名和密码。
通过 Claude Code (CLI)
最快的方式是在终端中运行指定命令,或者手动将配置添加到项目根目录的 .mcp.json 文件中(全局作用域可添加到 ~/.claude/mcp.json)。
通过 Claude Desktop
编辑对应平台的配置文件,保存后重启 Claude Desktop。
通过其他客户端
- Cursor:在项目根目录的
.cursor/mcp.json(项目作用域)或~/.cursor/mcp.json(全局)中添加配置。 - Windsurf:添加到
~/.codeium/windsurf/mcp_config.json。 - VS Code (Copilot):在项目根目录的
.vscode/mcp.json中添加配置。 - Gemini:添加到
~/.gemini/settings.json。
备用安装方式
- 全局安装:安装后可在任意配置中使用
"command": "codebeamer-mcp"(无需参数)替代 npx。 - 固定特定版本:可参考相关说明进行版本锁定。
- 从源码构建(开发):构建后可在
.mcp.json中使用"command": "node"和"args": ["dist/index.js"]。
适用场景
适用于需要将 Codebeamer ALM 与 MCP 客户端(如 Claude 等)集成的开发团队和项目管理场景,以便通过自然语言高效地管理项目、跟踪器、工作项、评论、风险等数据。
限制与注意事项
- 必须拥有可访问的 Codebeamer 实例(URL、用户名、密码)。
- 切勿将含有真实凭据的
.mcp.json文件提交到版本库,该文件已被列入.gitignore。 - 具体支持的 MCP 客户端版本和功能细节请参考官方文档。