Codebeamer

You run a dedicated MCP (Model Context Protocol) server for Codebeamer V3 APIs. It consolidates 30+ API calls into 12 intelligent, cached, rate-limited tools, speeding up data access and reducing unnecessary requests so you can build responsive integrations with Codebeamer.

How to use

Use the MCP server by starting it locally and connecting your MCP client to the provided Python-based server process. The server exposes 12 optimized tools that your client can invoke to perform common Codebeamer operations with built-in caching and rate limiting. Start by configuring your client to point at the MCP server and then call the specific tools you need. The server handles query optimization, caching, and throttle protection automatically, so you get faster, more reliable results without manually orchestrating multiple API calls.

How to install

pip install -r requirements.txt

export CODEBEAMER_URL="https://your-instance.com"
export CODEBEAMER_API_KEY="your-api-key"

# Start the MCP server
python mcp_server.py

Additional configuration and usage notes

Environment variables you may configure to optimize performance and security include CODEBEAMER_URL for your Codebeamer instance and CODEBEAMER_API_KEY for authentication. You can also tune per-minute API call limits and cache TTL if needed. Use CODEBEAMER_MAX_CALLS to cap the number of API calls per minute and CODEBEAMER_CACHE_TTL to control how long responses are cached.

Available tools

codebeamer_query_items

Query items across projects/trackers using CbQL, replacing multi-step API calls with a single optimized request.

codebeamer_get_project_complete

Fetch full project data including trackers and items in a single consolidated response.

codebeamer_get_tracker_complete

Retrieve full tracker data with all items, reducing the need for successive calls.

codebeamer_get_items_batch

Fetch multiple items by IDs in one call to minimize round-trips.

codebeamer_get_item_with_context

Obtain an item with its children, relations, and parent for full context.

codebeamer_create_item

Create new items in a tracker with automatic caching updates.

codebeamer_update_item

Update item fields with cache invalidation to keep data fresh.

codebeamer_bulk_update_items

Bulk update multiple items with a single request to reduce overhead.

codebeamer_manage_associations

Create, retrieve, or delete item associations to model relationships.

codebeamer_get_hierarchy_tree

Get a hierarchical structure of projects and trackers for navigation.

codebeamer_get_stats

Monitor API usage, cache performance, and rate limiting status.

codebeamer_clear_cache

Refresh cached data on demand to ensure fresh information.