Codebeamer MCP Server

1

Add it to Claude Code

Run this in a terminal.

Run in terminal
claude mcp add -e "CB_URL=${CB_URL}" -e "CB_USERNAME=${CB_USERNAME}" -e "CB_PASSWORD=${CB_PASSWORD}" codebeamer-mcp -- npx -y codebeamer-mcp
Required:CB_URLCB_USERNAMECB_PASSWORD
README.md

An MCP server for Codebeamer ALM to read and write projects, trackers, and items.

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_projects List all projects
get_project Get project details
list_trackers List trackers in a project
get_tracker Get tracker details
list_tracker_items List items in a tracker
search_items Full-text / cbQL search
get_item Get item details
get_item_relations Get outgoing/incoming associations (depends on, blocks, …)
get_item_references Get upstream/downstream traceability references (derived from, covers, …)
get_item_comments Get item comments
get_user Get user details

Write

Tool Description
create_item Create a new item in a tracker. Supports folders, item type, and parent nesting
update_item Update an existing item (name, description, status, priority, assignee, custom fields)
add_comment Add a comment to an item
create_association Create an association between two items (e.g. depends on, blocks)
create_reference Add a downstream traceability reference between two items
create_harm 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-mcp

Or 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 ~/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"
      }
    }
  }
}

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-mcp

Then 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
npx -y codebeamer-mcp Always fetches the latest version
npm install -g codebeamer-mcp Stays on installed version. Run npm update -g codebeamer-mcp to update
Pinned version (@0.2.0) Never auto-updates; change the version string manually

⚠️ Never commit .mcp.json with real credentials — it is listed in .gitignore.

From source (development)

git clone https://gith

Tools (17)

list_projectsList all projects
get_projectGet project details
list_trackersList trackers in a project
get_trackerGet tracker details
list_tracker_itemsList items in a tracker
search_itemsFull-text / cbQL search
get_itemGet item details
get_item_relationsGet outgoing/incoming associations
get_item_referencesGet upstream/downstream traceability references
get_item_commentsGet item comments
get_userGet user details
create_itemCreate a new item in a tracker
update_itemUpdate an existing item
add_commentAdd a comment to an item
create_associationCreate an association between two items
create_referenceAdd a downstream traceability reference between two items
create_harmCreate a harm entry in an RM Harms List tracker

Environment Variables

CB_URLrequiredThe URL of your Codebeamer instance API
CB_USERNAMErequiredYour Codebeamer username
CB_PASSWORDrequiredYour Codebeamer password

Configuration

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"}}}}

Try it

→List all projects available in my Codebeamer instance.
→Find all items in the 'Requirements' tracker that are currently in 'Draft' status.
→Create a new task in the 'Development' tracker with the title 'Fix login bug'.
→Get the traceability references for item ID 12345.
→Add a comment to item 54321 saying 'This issue has been verified'.

Frequently Asked Questions

What are the key features of Codebeamer MCP?

Full read access to projects, trackers, and items. Support for creating and updating items with custom fields. Traceability and association management between items. Full-text and cbQL search capabilities. Specialized support for RM Harms List entries.

What can I use Codebeamer MCP for?

Automating the creation of requirements or tasks from natural language descriptions. Querying project status and item details directly within the Claude interface. Managing traceability links between requirements and test cases. Updating item statuses and adding comments during development workflows.

How do I install Codebeamer MCP?

Install Codebeamer MCP by running: npx -y codebeamer-mcp

What MCP clients work with Codebeamer MCP?

Codebeamer MCP works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep Codebeamer MCP docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Need the old visual installer? Open Conare IDE.
Open Conare
View all other servers →

Related MCP Servers

Nuclear
Free, open-source music player without ads or tracking.
other17.1K stars
Domain Check
Fast domain availability checker with RDAP/WHOIS lookup and batch checking.
other253 stars
Ableton MCP Extended
Control Ableton Live using natural language via AI assistants
other142 stars
US Government Open Data MCP
MCP Server + TypeScript SDK for 40+ U.S. Government APIs
other90 stars
Garmin Connect
Access your fitness, health, and training data from MCP clients.
other71 stars
BinjaLattice MCP
Secure communication protocol for Binary Ninja and MCP servers
other61 stars