AI导哈

Codebeamer自然语言接口服务

Codebeamer MCP（模型上下文协议）服务器，允许Claude和其他MCP客户端使用自然语言读写Codebeamer中的项目、跟踪器和项目项。

  • by 3KniGHtcZ
  • TypeScript
  • 本地部署
  • 9 星标
  • 更新于
在 GitHub 查看 3KniGHtcZ/codebeamer-mcp

使用说明

码流器mcp

用于Codebeamer ALM的MCP（模型上下文协议）服务器。允许Claude和其他MCP客户端使用自然语言在Codebeamer中读写项目、跟踪器和项目。

工具（19）

阅读

工具 说明
list_projects 列出所有项目
get_project 获取项目详细信息
list_trackers 列出项目中的跟踪器
get_tracker 获取跟踪器详细信息
list_tracker_items 在跟踪器中列出项目
search_items 全文/cbQL搜索
get_item 获取项目摘要：ID、名称、跟踪器、状态和描述。轻量级——当您只需要识别项目并阅读其内容时使用
get_item_details 获取项目的完整结构化细节：项目、优先级、受让人、时间戳、故事点、自定义字段和测试步骤。省略描述--通过获取 get_item
get_item_relations 获取传出/传入关联（取决于、阻止等）
get_item_references 获取上游/下游可追溯性参考（来源于、覆盖物等）
get_item_comments 获取项目评论
get_item_reviews 获取某个项目的Review Hub评论（结果、评论者、投票）
get_user 获取用户详细信息

写

工具 说明
create_item 在跟踪器中创建新项目。支持文件夹、项目类型和父嵌套
update_item 更新现有项目（名称、描述、状态、优先级、受让人、自定义字段）
add_comment 向项目添加评论
create_association 在两个项目之间创建关联（例如，依赖、块）
create_reference 在两个项目之间添加下游可追溯性参考
create_harm 在RM伤害列表跟踪器中创建一个伤害条目，其中包含IMDRF代码和严重程度（1-5）

安装

需求

  • Node.js 20+
  • 访问Codebeamer实例（URL、用户名、密码）

克劳德代码（CLI）

最快的方法是在终端中运行此命令：

claude mcp add codebeamer -e CB_URL=https://your-instance.example.com/cb/api \
  -e CB_USERNAME=your_username -e CB_PASSWORD=your_password \
  -- npx -y codebeamer-mcp

或手动添加到 .mcp.json 在项目根目录中（或 ~/.claude/mcp.json 全球范围）：

{
  "mcpServers": {
    "codebeamer": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

克劳德桌面版

编辑您平台的配置文件：

平台 路径
macOS ~/Library/Application Support/Claude/claude_desktop_config.json
窗户 %APPDATA%\Claude\claude_desktop_config.json
Linux ~/.config/Claude/claude_desktop_config.json 
{
  "mcpServers": {
    "codebeamer": {
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

保存后重新启动Claude Desktop。

光标

增添 .cursor/mcp.json 在项目根（项目范围）中或 ~/.cursor/mcp.json （全球）：

{
  "mcpServers": {
    "codebeamer": {
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

帆板运动

增添 ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "codebeamer": {
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

VS代码（副本）

增添 .vscode/mcp.json 在项目根目录中：

{
  "servers": {
    "codebeamer": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

Gemini CLI

增添 ~/.gemini/settings.json:

{
  "mcpServers": {
    "codebeamer": {
      "command": "npx",
      "args": ["-y", "codebeamer-mcp"],
      "env": {
        "CB_URL": "https://your-instance.example.com/cb/api",
        "CB_USERNAME": "your_username",
        "CB_PASSWORD": "your_password"
      }
    }
  }
}

替代方案：全局安装

npm install -g codebeamer-mcp

然后使用 "command": "codebeamer-mcp" （没有 args)而不是 npx 在上面的任何配置中。

固定特定版本

"args": ["-y", "codebeamer-mcp@0.2.0"]

更新

方法 更新行为
npx -y codebeamer-mcp 始终获取最新版本
npm install -g codebeamer-mcp 保持安装版本不变。跑 npm update -g codebeamer-mcp 更新
固定版本(@0.2.0) 从不自动更新；手动更改版本字符串

⚠️ 永不承诺 .mcp.json 持有真实证件 --它列在 .gitignore.

来源（开发）

git clone https://github.com/3KniGHtcZ/codebeamer-mcp.git
cd codebeamer-mcp
npm install
npm run build

然后使用 "command": "node" 和 "args": ["dist/index.js"] 在你的 .mcp.json.

开发与测试

# Run tests (no real Codebeamer instance needed)
npm test

# Start the mock API server (port 3001)
node mock-server.mjs

# Interactive testing via MCP Inspector
CB_URL=http://localhost:3001 CB_USERNAME=mock CB_PASSWORD=mock \
  npx @modelcontextprotocol/inspector node dist/index.js

配置

变量 描述 默认值
CB_URL 编码波束形成器API URL，例如。 https://your-instance.example.com/cb/api （服务器附加 /v3 自动） （必填）
CB_USERNAME 登录用户名 （必填）
CB_PASSWORD 密码 （必填）
CB_UNSAFE_SSL 设置为 true 允许使用未验证/自签名证书连接到服务器 false
CB_API_VERSION API版本 v3
CB_TIMEOUT_MS 请求超时（ms） 30000
CB_MAX_ITEMS 每页最大项目数 100

相关 MCP