@edicarlos.lds/businessmap-mcp

BusinessMap MCP Server

Model Context Protocol server for BusinessMap (Kanbanize) integration.

Installation

Via NPX (Recommended)

You can run the BusinessMap MCP server directly using npx without installing it globally:

npx @edicarlos.lds/businessmap-mcp

Global Installation

npm install -g @edicarlos.lds/businessmap-mcp

Configuration

Environment Variables

The server requires the following environment variables:

• BUSINESSMAP_API_TOKEN: Your BusinessMap API token
• BUSINESSMAP_API_URL: Your BusinessMap API URL (e.g., https://your-account.kanbanize.com/api/v2)
• BUSINESSMAP_READ_ONLY_MODE: Set to "true" for read-only mode, "false" to allow modifications (optional, defaults to "false")
• BUSINESSMAP_DEFAULT_WORKSPACE_ID: Set the BusinessMap workspace ID (optional)

Claude Desktop

Add the following configuration to your claude_desktop_config.json file:

Using NPX:

{
  "mcpServers": {
    "Businessmap": {
      "command": "npx",
      "args": ["-y", "@edicarlos.lds/businessmap-mcp"],
      "env": {
        "BUSINESSMAP_API_TOKEN": "your_token_here",
        "BUSINESSMAP_API_URL": "https://your-account.kanbanize.com/api/v2",
        "BUSINESSMAP_READ_ONLY_MODE": "false", // optional
        "BUSINESSMAP_DEFAULT_WORKSPACE_ID": "1" // optional
      }
    }
  }
}

Using Global Installation:

{
  "mcpServers": {
    "Businessmap": {
      "command": "businessmap-mcp",
      "env": {
        "BUSINESSMAP_API_TOKEN": "your_token_here",
        "BUSINESSMAP_API_URL": "https://your-account.kanbanize.com/api/v2",
        "BUSINESSMAP_READ_ONLY_MODE": "false", // optional
        "BUSINESSMAP_DEFAULT_WORKSPACE_ID": "1" // optional
      }
    }
  }
}

Other MCP Clients

For other MCP clients, use the appropriate configuration format for your client, ensuring you specify:

• Command: npx @edicarlos.lds/businessmap-mcp (or businessmap-mcp if globally installed)
• Environment variables: BUSINESSMAP_API_TOKEN, BUSINESSMAP_API_URL, and optionally BUSINESSMAP_READ_ONLY_MODE, BUSINESSMAP_DEFAULT_WORKSPACE_ID

Manual Setup

• Clone this repository:

  git clone https://github.com/edicarloslds/businessmap-mcp.git
  cd businessmap-mcp
  

• Install dependencies:

  npm install
  

• Create a .env file with your BusinessMap credentials (for development/testing):

  BUSINESSMAP_API_TOKEN=your_token_here
  BUSINESSMAP_API_URL=https://your-account.kanbanize.com/api/v2
  BUSINESSMAP_READ_ONLY_MODE=false
  BUSINESSMAP_DEFAULT_WORKSPACE_ID=1
  

  Note: When using as an MCP server with Claude Desktop, you don't need a .env file. Configure the environment variables directly in your MCP client configuration instead.

Environment Variables

• BUSINESSMAP_API_TOKEN (required): Your BusinessMap API token
• BUSINESSMAP_API_URL (required): Your BusinessMap API URL (e.g., https://your-account.kanbanize.com/api/v2)
• BUSINESSMAP_READ_ONLY_MODE (optional): Set to true to prevent write operations (default: false)
• BUSINESSMAP_DEFAULT_WORKSPACE_ID (optional): Default workspace ID to use when not specified in operations

• Build the project:

  npm run build
  

• Start the server:

  npm start
  

Usage

The BusinessMap MCP server provides the following tools:

Workspace Management

• list_workspaces - Get all workspaces
• get_workspace - Get workspace details
• create_workspace - Create new workspace

Board Management

• list_boards - List boards in workspace(s)
• search_board - Search for boards by ID or name
• get_board - Get board details with structure
• create_board - Create new board (if not in read-only mode)
• get_columns - Get all columns for a board
• get_lanes - Get all lanes for a board
• get_lane - Get details of a specific lane/swimlane
• create_lane - Create new lane/swimlane (if not in read-only mode)

Card Management

• list_cards - Get cards from a board with optional filters
• get_card - Get detailed card information
• get_card_size - Get the size/points of a specific card
• get_card_comments - Get all comments for a specific card
• get_card_comment - Get details of a specific comment from a card
• create_card - Create new card
• move_card - Move card to different column/swimlane
• update_card - Update card properties
• set_card_size - Set the size/points of a specific card

Custom Field Management

• get_custom_field - Get details of a specific custom field by ID

Workflow & Cycle Time Analysis

• get_workflow_cycle_time_columns - Get workflow's cycle time columns
• get_workflow_effective_cycle_time_columns - Get workflow's effective cycle time columns

User Management

• list_users - Get all users
• get_user - Get user details
• get_current_user - Get current logged user details

System

• health_check - Check API connection
• get_api_info - Get API information

Development

Setup Development Environment

# Install dependencies
npm install

# Run in development mode
npm run dev

# Watch for changes
npm run watch

# Build for production
npm run build

# Run tests
npm test

# Lint code
npm run lint

Docker Support

# Build Docker image
npm run docker:build

# Run with Docker Compose
npm run docker:up

# View logs
npm run docker:logs

# Stop containers
npm run docker:down

Troubleshooting

Connection Issues

The server now includes automatic connection verification during startup. If you encounter connection issues:

• Check your environment variables:

  echo $BUSINESSMAP_API_URL
  echo $BUSINESSMAP_API_TOKEN
  

• Test the connection manually:

  chmod +x scripts/test-connection.sh
  ./scripts/test-connection.sh
  

• Common issues:

  • Invalid API URL: Ensure your URL follows the format https://your-account.kanbanize.com/api/v2
  • Invalid API Token: Verify your token has the necessary permissions

Startup Process

The server now performs the following steps during initialization:

• Configuration validation - Checks all required environment variables
• API connection verification - Tests connectivity with up to 3 retry attempts
• Authentication check - Verifies API token permissions
• Server startup - Starts the MCP server only after successful connection

If the connection fails, the server will display detailed error messages and retry automatically.

Development

Release Process

This project uses an automated release process. See RELEASE_PROCESS.md for detailed documentation.

Quick Start:

# Preview release notes
npm run preview:release

# Publish new version (interactive)
npm run publish

The release process automatically:

• Bumps version (patch/minor/major)
• Generates release notes from commits
• Creates GitHub tags and releases
• Publishes to NPM

Contributing

• Follow conventional commit format for better release notes:

  feat: add new feature
  fix: resolve bug
  docs: update documentation
  refactor: improve code structure
  

• Ensure all tests pass before submitting PR:

  npm test
  npm run test:npx
  

License

MIT

Support

For issues and questions:

• Check the Issues page
• Review BusinessMap API documentation
• Verify your environment configuration
• Submit a new issue with detailed information

Related Projects

• Model Context Protocol - Official MCP documentation
• BusinessMap API Documentation - Official API reference
• MCP TypeScript SDK - Official MCP SDK