codebeamer-mcp

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

codebeamer-mcp MCP server

工具 (18)

读取

工具	描述
`list_projects`	列出所有项目
`get_project`	获取项目详情
`list_trackers`	列出项目中的跟踪器
`get_tracker`	获取跟踪器详情
`list_tracker_items`	列出跟踪器中的条目
`search_items`	全文 / cbQL 搜索
`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、用户名、密码）

Claude Code (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"
      }
    }
  }
}

Claude Desktop

编辑您平台的配置文件：

平台	路径
macOS	`~/Library/Application Support/Claude/claude_desktop_config.json`
Windows	`%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

添加到项目根目录下的 .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"
      }
    }
  }
}

Windsurf

添加到 ~/.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 Code (Copilot)

添加到项目根目录下的 .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

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

开发与测试

# 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`	Codebeamer 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`

codebeamer-mcp

codebeamer-mcp

工具 (18)

读取

写入

安装

要求

Claude Code (CLI)

Claude Desktop

Cursor

Windsurf

VS Code (Copilot)

Gemini CLI

替代方案：全局安装

固定特定版本

更新

从源码安装（开发）

开发与测试

配置

Resources

Tools

Latest Blog Posts

MCP directory API