trackmcp
Back to directory
edicarloslds

businessmap-mcp

View on GitHub
3 stars TypeScriptOthers Updated Oct 13, 2025

Documentation

BusinessMap MCP Server

npm version
GitHub release
npm downloads
License: MIT
Node.js Version
TypeScript
MCP
GitHub Sponsors

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

  • 27 agent-oriented MCP tools by default, with a 93-tool full profile for advanced operations
  • 6 MCP resources for direct workspace, board, and paginated card reads
  • 4 guided prompts for board analysis, reporting, card creation, and workspace summaries
  • Optional read-only mode for safer exploration
  • `stdio` transport 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`:

bash
npx -y @edicarlos.lds/businessmap-mcp

Or install globally:

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

The server requires Node.js 22 or newer.

Required Configuration

Set these environment variables in your MCP client, shell, deployment platform, or local `.env` file:

env
BUSINESSMAP_API_TOKEN=your_token_here
BUSINESSMAP_API_URL=https://your-account.kanbanize.com/api/v2

Optional settings:

VariableDefaultDescription
`BUSINESSMAP_READ_ONLY_MODE``false`Use `true` to register only read-only tools.
`BUSINESSMAP_DEFAULT_WORKSPACE_ID`unsetDefault workspace ID for tools that can use one.
`BUSINESSMAP_TOOL_PROFILE``essential`Agent-oriented catalog with progressive disclosure. Use `full` for all advanced operations.
`LOG_LEVEL``1``0` debug, `1` info, `2` warn, `3` error, `4` none.
`LOG_FORMAT``text`Use `json` for structured logs.
`TRANSPORT``stdio`Use `stdio` or `http`.
`PORT``3000`HTTP server port.
`ALLOWED_ORIGINS``http://localhost`CORS allowlist for HTTP mode.
`ALLOWED_HOSTS`unsetHost header allowlist for HTTP mode.
`HTTP_BODY_LIMIT``1mb`Maximum JSON request body size (`b`, `kb`, or `mb`).
`HTTP_MAX_SESSIONS``100`Maximum concurrent initialized HTTP sessions.
`HTTP_SESSION_TIMEOUT_MS``1800000`Idle session timeout in milliseconds.

MCP Client Setup

Most MCP clients need the same command and environment variables:

json
{
  "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:

> Security: The HTTP transport does not enable authentication by default.

> Do not expose it publicly without TLS, authentication, authorization, and

> rate limiting. See Programmatic middleware and

> Security Policy.

bash
TRANSPORT=http \
PORT=3000 \
ALLOWED_ORIGINS=https://your-client.example.com \
ALLOWED_HOSTS=your-server.example.com \
npm start

Configure your MCP client with:

text
http://your-server:3000/mcp

Use `/health` for liveness and `/ready` for readiness. The server stops

accepting new sessions when capacity is exhausted and closes active sessions

gracefully on `SIGINT` or `SIGTERM`.

For custom authentication, authorization, logging, or rate limiting, see docs/MIDDLEWARE.md.

Local Development

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

Create a local `.env` file:

env
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

Useful commands:

bash
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 npx

Docker

bash
npm run docker:build
npm run docker:up
npm run docker:logs
npm run docker:down

Troubleshooting

If startup fails, check the two required environment variables first:

bash
echo $BUSINESSMAP_API_URL
echo $BUSINESSMAP_API_TOKEN

Then test the BusinessMap connection:

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

Common causes:

  • `BUSINESSMAP_API_URL` is not in the expected format: `https://your-account.kanbanize.com/api/v2`
  • `BUSINESSMAP_API_TOKEN` is 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

Contributing

See CONTRIBUTING.md for local setup, project structure, and pull request guidance.

Use conventional commits when possible:

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

Before opening a pull request:

bash
npm run lint
npm test -- --runInBand
npm run build
npm run knip

`npm run test:npx` is an optional API-backed smoke test and requires BusinessMap credentials.

Support

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

Sponsors

If this project helps you, consider supporting it through GitHub Sponsors.

License

MIT

Frequently asked questions

What is businessmap-mcp?

businessmap-mcp is a Model Context Protocol (MCP) server listed in the TrackMCP directory.

How do I install businessmap-mcp?

Open the GitHub repository and follow its README. Most MCP servers are added to your client's MCP config, then called by your agent.

Is businessmap-mcp open source?

Yes — it is hosted on GitHub at https://github.com/edicarloslds/businessmap-mcp and has 3 stars.

Related MCP tools

Run your own MCP server? See who uses it and what to fix.

Measure it with TrackMCP