Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CB_URL | Yes | Codebeamer API URL, e.g. https://your-instance.example.com/cb/api (the server appends /v3 automatically) | |
| CB_PASSWORD | Yes | Password | |
| CB_USERNAME | Yes | Login username | |
| CB_MAX_ITEMS | No | Max items per page | 100 |
| CB_TIMEOUT_MS | No | Request timeout (ms) | 30000 |
| CB_API_VERSION | No | API version | v3 |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_projects | List all Codebeamer projects the authenticated user can access. Returns a summary table with project IDs, names, and keys. Use the returned IDs to fetch trackers or items. |
| get_project | Get full details for a single Codebeamer project by its numeric ID. |
| list_trackers | List all trackers (Requirements, Bugs, Test Cases, etc.) in a Codebeamer project. Use the returned tracker IDs to list items or get tracker details. |
| get_tracker | Get details of a Codebeamer tracker including its field schema. The field list shows what fields are available for items in this tracker, useful for constructing cbQL queries. |
| search_items | Search Codebeamer items using cbQL query language. Examples: 'tracker.id IN (42) AND status.name = "Open"', 'summary LIKE "login bug"', 'priority.name = "High" AND assignedTo.name = "john.doe"', 'project.id IN (1) AND modifiedAt >= -1w'. Use get_tracker to see available fields for a tracker. |
| list_tracker_items | List all items in a specific Codebeamer tracker with pagination. Returns a table with item IDs, summaries, statuses, and priorities. |
| get_item | Get full details of a Codebeamer work item by its numeric ID. Returns status, priority, assignees, description, and custom fields. |
| get_item_relations | Get all relations (associations) for a Codebeamer item. Shows incoming and outgoing links like 'depends on', 'blocks', 'derived from', etc. |
| get_item_references | Get upstream and downstream traceability references for a Codebeamer item. Upstream references point to items this one is derived from (e.g. requirements). Downstream references point to items derived from this one (e.g. test cases). |
| get_item_comments | Get all comments (discussion thread) for a Codebeamer item. |
| get_user | Get profile details for a Codebeamer user by their numeric ID. User IDs appear in item fields like assignedTo and createdBy. |
| create_item | Create a new work item in a Codebeamer tracker. Use get_tracker to discover available fields, statuses, and priorities. Returns the created item with all fields. |
| update_item | Update fields on an existing Codebeamer work item. Only provide the fields you want to change. Returns the updated item with all fields. |
| add_comment | Add a comment to a Codebeamer work item. Supports plain text and wiki markup formats. Returns the created comment. |
| create_association | Create an association (link) between two Codebeamer work items. Common association types: 'depends on', 'blocks', 'related to', 'derived from'. Use get_item_relations on an existing item to discover valid association type IDs. |
| create_reference | Add a downstream reference from one Codebeamer item to another. Downstream references represent derivation/traceability links (e.g. a requirement derived from another). The 'from' item gets the downstream reference pointing to the 'to' item. |
| create_harm | Create a new item in a Codebeamer RM Harms List tracker. Supports setting the IMDRF code (text) and Severity (integer 1–5). Use list_trackers to find the Harms List tracker ID for your project. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |