codebeamer-mcp
The codebeamer-mcp server provides an MCP interface for natural language interaction with Codebeamer ALM, enabling you to manage projects, trackers, and work items via Claude and other MCP clients (Claude Desktop, Cursor, Windsurf, VS Code Copilot, Gemini CLI).
Read Operations
List/retrieve projects, trackers, and work items (with pagination)
Get tracker details including field schema, statuses, and priorities
Search items via full-text or structured cbQL queries (filter by status, priority, assignee, date, etc.)
Get item details: custom fields, status, priority, assignees
Get item relations (associations), traceability references (upstream/downstream), and comments
Look up user profiles
Write Operations
Create items – with support for folders, item types, parent nesting, assignees, status, priority, story points, and descriptions
Update items – modify name, description, status, priority, assignees, and story points
Add comments – in plain text or wiki markup
Create associations – link items with typed relations (e.g., depends on, blocks, related to)
Create traceability references – add downstream references between items
Create harm entries – specialized creation in RM Harms List trackers with IMDRF codes and severity ratings (1–5)
codebeamer-mcp
An MCP (Model Context Protocol) server for Codebeamer ALM. Allows Claude and other MCP clients to read and write projects, trackers, and items in Codebeamer using natural language.
Tools (17)
Read
Tool | Description |
| List all projects |
| Get project details |
| List trackers in a project |
| Get tracker details |
| List items in a tracker |
| Full-text / cbQL search |
| Get item details |
| Get outgoing/incoming associations (depends on, blocks, …) |
| Get upstream/downstream traceability references (derived from, covers, …) |
| Get item comments |
| Get user details |
Write
Tool | Description |
| Create a new item in a tracker. Supports folders, item type, and parent nesting |
| Update an existing item (name, description, status, priority, assignee, custom fields) |
| Add a comment to an item |
| Create an association between two items (e.g. depends on, blocks) |
| Add a downstream traceability reference between two items |
| Create a harm entry in an RM Harms List tracker with IMDRF code and severity (1–5) |
Installation
Requirements
Node.js 20+
Access to a Codebeamer instance (URL, username, password)
Claude Code (CLI)
The fastest way — run this command in your terminal:
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-mcpOr add it manually to .mcp.json in the project root (or ~/.claude/mcp.json for global scope):
{
"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
Edit the config file for your platform:
Platform | Path |
macOS |
|
Windows |
|
Linux |
|
{
"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"
}
}
}
}Restart Claude Desktop after saving.
Cursor
Add to .cursor/mcp.json in the project root (project scope) or ~/.cursor/mcp.json (global):
{
"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
Add to ~/.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)
Add to .vscode/mcp.json in the project root:
{
"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
Add to ~/.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"
}
}
}
}Alternative: global install
npm install -g codebeamer-mcpThen use "command": "codebeamer-mcp" (no args) instead of npx in any config above.
Pinning a specific version
"args": ["-y", "codebeamer-mcp@0.2.0"]Updates
Method | Update behavior |
| Always fetches the latest version |
| Stays on installed version. Run |
Pinned version ( | Never auto-updates; change the version string manually |
⚠️ Never commit
.mcp.jsonwith real credentials — it is listed in.gitignore.
From source (development)
git clone https://github.com/3KniGHtcZ/codebeamer-mcp.git
cd codebeamer-mcp
npm install
npm run buildThen use "command": "node" with "args": ["dist/index.js"] in your .mcp.json.
Development & Testing
# 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.jsConfiguration
Variable | Description | Default |
| Codebeamer API URL, e.g. | (required) |
| Login username | (required) |
| Password | (required) |
| Set to |
|
| API version |
|
| Request timeout (ms) |
|
| Max items per page |
|
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/3KniGHtcZ/codebeamer-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server