Documentation
BusinessMap MCP Server
Model Context Protocol (MCP) server for BusinessMap/Kanbanize. It gives AI clients access to BusinessMap workspaces, boards, cards, users, custom fields, workflow cycle-time data, resources, and guided prompts.
What You Get
- 59 MCP tools for workspaces, boards, cards, users, custom fields, workflow analysis, and health checks
- 5 MCP resources for direct workspace, board, and card reads
- 4 guided prompts for board analysis, reporting, card creation, and workspace summaries
- Optional read-only mode for safer exploration
stdiotransport for local MCP clients and HTTP transport for remote usage- Docker, structured logging, and programmatic middleware support
See the full catalog in docs/TOOLS.md.
Quick Start
Run directly with npx:
npx -y @edicarlos.lds/businessmap-mcpOr install globally:
npm install -g @edicarlos.lds/businessmap-mcp
businessmap-mcpThe server requires Node.js 18 or newer.
Required Configuration
Set these environment variables in your MCP client, shell, deployment platform, or local .env file:
BUSINESSMAP_API_TOKEN=your_token_here
BUSINESSMAP_API_URL=https://your-account.kanbanize.com/api/v2Optional settings:
| Variable | Default | Description |
|---|---|---|
BUSINESSMAP_READ_ONLY_MODE | false | Use true to register only read-only tools. |
BUSINESSMAP_DEFAULT_WORKSPACE_ID | unset | Default workspace ID for tools that can use one. |
LOG_LEVEL | 1 | 0 debug, 1 info, 2 warn, 3 error, 4 none. |
TRANSPORT | stdio | Use stdio or http. |
PORT | 3000 | HTTP server port. |
ALLOWED_ORIGINS | http://localhost | CORS allowlist for HTTP mode. |
ALLOWED_HOSTS | unset | Host header allowlist for HTTP mode. |
MCP Client Setup
Most MCP clients need the same command and environment variables:
{
"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"
}
}
}
}Client-specific examples for Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Zed, and other MCP clients are in docs/MCP_CLIENTS.md.
HTTP Mode
Use HTTP mode when deploying the server remotely or when your client supports Streamable HTTP:
TRANSPORT=http \
PORT=3000 \
ALLOWED_ORIGINS=https://your-client.example.com \
ALLOWED_HOSTS=your-server.example.com \
npm startConfigure your MCP client with:
http://your-server:3000/mcpFor custom authentication, authorization, logging, or rate limiting, see docs/MIDDLEWARE.md.
Local Development
git clone https://github.com/edicarloslds/businessmap-mcp.git
cd businessmap-mcp
npm installCreate a local .env file:
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=1Useful commands:
npm run dev # Run from TypeScript source
npm run watch # Run and reload on changes
npm run build # Build dist/
npm test # Run tests
npm run lint # Run ESLint
npm run test:npx # Test package execution through npxDocker
npm run docker:build
npm run docker:up
npm run docker:logs
npm run docker:downTroubleshooting
If startup fails, check the two required environment variables first:
echo $BUSINESSMAP_API_URL
echo $BUSINESSMAP_API_TOKENThen test the BusinessMap connection:
chmod +x scripts/test-connection.sh
./scripts/test-connection.shCommon causes:
BUSINESSMAP_API_URLis not in the expected format:https://your-account.kanbanize.com/api/v2BUSINESSMAP_API_TOKENis missing, expired, or lacks the needed permissions- The selected MCP client has not been fully restarted after editing its config
Logging details are documented in docs/LOGGING.md.
Project Docs
- Tools, resources, and prompts
- MCP client configuration
- Logging
- Programmatic middleware
- Release process
- Scripts
Contributing
Use conventional commits when possible:
feat: add new feature
fix: resolve bug
docs: update documentation
refactor: improve code structureBefore opening a pull request:
npm test
npm run test:npxSupport
For issues and questions:
1. Check existing GitHub issues
2. Review the BusinessMap API documentation
3. Verify your environment configuration
4. Open a new issue with the error message, runtime command, and relevant MCP client configuration
Related Projects
Sponsors
If this project helps you, consider supporting it through GitHub Sponsors.
License
MIT
Similar MCP
Based on tags & features
Trending MCP
Most active this week