karbon

This MCP server provides integration with the Karbon API, enabling you to interact with Karbon clients and work items through the Model Context Protocol. It exposes tools to search for clients across multiple types, retrieve specific client details, and fetch work items associated with a client as well as individual work items. Once the server is running via your MCP interface, you can issue tool calls to access these capabilities. The available tools are: search_clients, get_client_by_id, get_work_items, and get_work_item_by_id. For example, you can search for clients using a name or term, fetch a particular client by its ID, list work items for a given client, or retrieve a specific work item by its key. The server uses Karbon API credentials provided via environment variables to authenticate requests.

Prerequisites:

• Node.js installed on your system
• Access to Karbon API credentials (Bearer Token and Access Key)

Step-by-step installation:

1. Install dependencies npm install

2. Build the server npm run build

3. Set Karbon API credentials as environment variables

   • Windows (Command Prompt) set KARBON_BEARER_TOKEN=your_bearer_token_here set KARBON_ACCESS_KEY=your_access_key_here

   • Windows (PowerShell) $env:KARBON_BEARER_TOKEN="your_bearer_token_here" $env:KARBON_ACCESS_KEY="your_access_key_here"

   • Linux/macOS export KARBON_BEARER_TOKEN=your_bearer_token_here export KARBON_ACCESS_KEY=your_access_key_here

4. Add to MCP configuration In your MCP settings file (example path shown in README), configure the server:

   { "mcpServers": { "karbon-server": { "command": "node", "args": ["/path/to/karbon-mcp-server/build/index.js"], "env": { "KARBON_BEARER_TOKEN": "your_bearer_token_here", "KARBON_ACCESS_KEY": "your_access_key_here" } } } }

Note: Replace /path/to/karbon-mcp-server/ with the actual path where you cloned/repo downloaded this server.

Tips and common considerations:

• Ensure the Karbon API credentials have the necessary permissions for the operations you intend to perform (read access to clients and work items).
• Double-check that the environment variables are correctly exported in the environment where your MCP interface starts the server.
• If you update or rebuild the server, restart the MCP connection to pick up changes.
• When configuring the MCP settings, ensure the path to build/index.js is accurate after running npm run build.
• If you encounter authentication errors, re-verify the tokens in Karbon and ensure there are no extra quotes or trailing spaces in the environment values.