# 3KniGHtcZ/codebeamer-mcp [Health: Active]

**Category:** 📋 Product Management  
**Repository:** https://github.com/3KniGHtcZ/codebeamer-mcp  
**GitHub Stars:** 9  
**npm Downloads (last month):** 156  
**Views:** 10  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/3knightcz-codebeamer-mcp

## Description
Codebeamer ALM integration for managing work items, trackers, and projects. Provides 17 tools for reading and writing items, associations, references, comments, and risk management data via Codebeamer REST API v3.

## Tools
Capabilities this server exposes over MCP:

- **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 summary: ID, name, tracker, status and description. Lightweight — use when you only need to identify the item and read its content
- **get_item_details** — Get full structured detail of an item: project, priority, assignees, timestamps, story points, custom fields and test steps. Description omitted — fetch it via `get_item
- **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_item_reviews** — Get Review Hub reviews for an item (result, reviewers, votes)
- **get_user** — Get user details
- **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)

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

```json
"mcpServers": {
  "codebeamer-mcp": {
    "command": "npx",
    "args": ["-y","codebeamer-mcp"],
    "env": {
      "CB_URL": "",
      "CB_USERNAME": "",
      "CB_PASSWORD": "",
      "CB_UNSAFE_SSL": "",
      "CB_API_VERSION": "",
      "CB_TIMEOUT_MS": "",
      "CB_MAX_ITEMS": ""
    }
  }
}
```

**Requires environment variables:** `CB_URL`, `CB_USERNAME`, `CB_PASSWORD`, `CB_UNSAFE_SSL`, `CB_API_VERSION`, `CB_TIMEOUT_MS`, `CB_MAX_ITEMS` — the values above are empty placeholders; fill in real credentials before running (see the repository for what each one is for).

## Documentation

## What 3KniGHtcZ/codebeamer-mcp does

The 3KniGHtcZ/codebeamer-mcp MCP server connects an MCP client to a Codebeamer ALM instance. It provides tools for navigating projects and trackers, finding work items, reading item content and structured fields, and retrieving related lifecycle information.

Read operations cover project and tracker metadata, tracker contents, full-text or cbQL searches, item summaries, detailed item data, relations, traceability references, comments, Review Hub reviews, and user records. Detailed item results can include priority, assignees, timestamps, story points, custom fields, and test steps. The lightweight item lookup includes the description, while the detailed lookup omits it.

Write operations can create and update tracker items, add comments, connect items with associations, add downstream traceability references, and create harm entries in an RM Harms List tracker. Harm creation accepts an IMDRF code and a severity from 1 through 5.

## How it works

The server runs as a local standard-input/output process and sends requests to Codebeamer’s REST API. The configured base URL identifies the Codebeamer API endpoint; the server appends the configured API version path, which defaults to `v3`. MCP clients invoke the exposed tools, while Codebeamer performs the underlying project, tracker, item, review, and risk-management operations.

The repository documents configuration for Claude Code, Claude Desktop, Cursor, Windsurf, VS Code Copilot, and Gemini CLI. The listed MCP configurations use `npx -y codebeamer-mcp` as the process command. A global npm installation or a build from source is also documented.

## Setup and configuration

The 3KniGHtcZ/codebeamer-mcp server requires Node.js 20 or newer and access to a Codebeamer instance. Set these required variables before starting it:

- `CB_URL`: Codebeamer API URL. The server adds `/v3` by default.
- `CB_USERNAME`: Codebeamer login username.
- `CB_PASSWORD`: Codebeamer password.

Optional settings control connection and request behavior:

- `CB_UNSAFE_SSL`: Set to `true` for unverified or self-signed certificates; the default is `false`.
- `CB_API_VERSION`: API version, defaulting to `v3`.
- `CB_TIMEOUT_MS`: Request timeout in milliseconds, defaulting to `30000`.
- `CB_MAX_ITEMS`: Maximum items per page, defaulting to `100`.

The README warns against committing MCP configuration files containing real credentials. For development, the project includes npm build and test commands and a mock API server that does not require a real Codebeamer instance.

## Tools and capabilities

The tool set is divided into read and write operations. Read tools can enumerate projects, inspect trackers, search items, retrieve item metadata, and examine relations, references, comments, reviews, and users. Write tools support item creation and updates, comments, item associations, traceability references, and RM harm records.

Item creation supports folders, item types, and parent nesting. Item updates can change names, descriptions, status, priority, assignee, and custom fields. Associations can represent links such as dependencies or blocking relationships, while references support downstream traceability between items.

## Limitations and notes

The 3KniGHtcZ/codebeamer-mcp server depends on a reachable Codebeamer deployment and valid username and password credentials. Its documented API target is Codebeamer REST API v3 by default, although the API version can be changed through configuration. Operations and returned fields depend on the permissions, trackers, item types, custom fields, and Review Hub data available in the connected Codebeamer instance.

The project documentation lists Claude Code, Claude Desktop, Cursor, Windsurf, VS Code Copilot, and Gemini CLI configurations. It does not document an OAuth flow or API-key authentication; setup uses Codebeamer username and password variables instead.

## Getting started with this 3KniGHtcZ/codebeamer-mcp MCP server
Always refer to the official documentation for the most accurate and up-to-date information.

_Full upstream README: https://allmcps.com/mcp/3knightcz-codebeamer-mcp/readme_