codebeamer-mcp

Codebeamer MCP is a server based on the Model Context Protocol (MCP) used to connect to the Codebeamer ALM system. Its main purpose is to enable Claude and other MCP-compatible clients to interact with Codebeamer through natural language, achieving reading and writing of data such as projects, trackers, and work items.

Main Capabilities

• Read and write projects, trackers, and work items in Codebeamer.
• Operate on associations, references, comments, and risk management data.
• Communicate with Codebeamer instances through the REST API.

Usage

Before use, you need to prepare access information for the Codebeamer instance, including URL, username, and password.

Via Claude Code (CLI)

The fastest way is to run the specified command in the terminal, or manually add the configuration to the project root directory's .mcp.json file (for global scope, it can be added to ~/.claude/mcp.json).

Via Claude Desktop

Edit the configuration file for the corresponding platform, save it, and restart Claude Desktop.

Via Other Clients

• Cursor: Add the configuration in the project root directory's .cursor/mcp.json(project scope) or ~/.cursor/mcp.json(global).
• Windsurf: Add to ~/.codeium/windsurf/mcp_config.json.
• VS Code (Copilot): Add the configuration in the project root directory's .vscode/mcp.json .
• Gemini: Add to ~/.gemini/settings.json.

Alternative Installation Methods

• Global Installation: After installation, you can use "command": "codebeamer-mcp"(no arguments required) instead of npx in any configuration.
• Pin a Specific Version: Refer to the relevant instructions for version locking.
• Build from Source (Development): After building, you can use .mcp.json with "command": "node" and "args": ["dist/index.js"].

Applicable Scenarios

Suitable for development teams and project management scenarios that need to integrate Codebeamer ALM with MCP clients (such as Claude, etc.), so as to efficiently manage data such as projects, trackers, work items, comments, and risks through natural language.

Limitations and Notes

• You must have an accessible Codebeamer instance (URL, username, password).
• Never commit a .mcp.json file containing real credentials to the version repository; this file has been included in .gitignore.
• For specific supported MCP client versions and feature details, please refer to the official documentation.