@edicarlos.lds/businessmap-mcp

中文文档
4.3.4发布于 2026/11/13MITTypeScriptES Module构建来源已验证近 30 天下载 2242

Model Context Protocol server for BusinessMap (Kanbanize) integration

原始使用文档
文档目录14 节
  1. What You Get
  2. Quick Start
  3. Required Configuration
  4. MCP Client Setup
  5. HTTP Mode
  6. Local Development
  7. Docker
  8. Troubleshooting
  9. Project Docs
  10. Contributing
  11. Support
  12. Related Projects
  13. Sponsors
  14. License

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:

npx -y @edicarlos.lds/businessmap-mcp

Or install globally:

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:

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

Optional settings:

VariableDefaultDescription
BUSINESSMAP_READ_ONLY_MODEfalseUse true to register only read-only tools.
BUSINESSMAP_DEFAULT_WORKSPACE_IDunsetDefault workspace ID for tools that can use one.
BUSINESSMAP_TOOL_PROFILEessentialAgent-oriented catalog with progressive disclosure. Use full for all advanced operations.
LOG_LEVEL10 debug, 1 info, 2 warn, 3 error, 4 none.
LOG_FORMATtextUse json for structured logs.
TRANSPORTstdioUse stdio or http.
PORT3000HTTP server port.
ALLOWED_ORIGINShttp://localhostCORS allowlist for HTTP mode.
ALLOWED_HOSTSunsetHost header allowlist for HTTP mode.
HTTP_BODY_LIMIT1mbMaximum JSON request body size (b, kb, or mb).
HTTP_MAX_SESSIONS100Maximum concurrent initialized HTTP sessions.
HTTP_SESSION_TIMEOUT_MS1800000Idle session timeout in milliseconds.

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:

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.

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

Configure your MCP client with:

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

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

Create 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=1

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

Docker

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:

echo $BUSINESSMAP_API_URL
echo $BUSINESSMAP_API_TOKEN

Then test the BusinessMap connection:

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:

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

Before opening a pull request:

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

版本与发布记录

@edicarlos.lds/businessmap-mcp 共发布 40 个版本,首次发布于 2025/07/29;过去 12 个月发布了 24 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.3.4latest2026/11/13今天
4.3.32026/11/13今天
4.3.22026/11/121 天前
4.3.12026/11/121 天前
4.3.02026/11/121 天前
4.2.02026/11/121 天前

关于 @edicarlos.lds/businessmap-mcp 的常见问题

@edicarlos.lds/businessmap-mcp 是什么?

Model Context Protocol server for BusinessMap (Kanbanize) integration

如何安装 @edicarlos.lds/businessmap-mcp?

在项目目录运行 npm install @edicarlos.lds/businessmap-mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 businessmap-mcp,可以用 npx businessmap-mcp 直接运行。

@edicarlos.lds/businessmap-mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@edicarlos.lds/businessmap-mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@edicarlos.lds/businessmap-mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@edicarlos.lds/businessmap-mcp 可以商用吗?

@edicarlos.lds/businessmap-mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@edicarlos.lds/businessmap-mcp 的下载量有多少?

根据 npm 官方下载统计,@edicarlos.lds/businessmap-mcp 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,242 次,日均约 75 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@edicarlos.lds/businessmap-mcp 还在维护吗?

最新版本 4.3.4 发布于 2026/11/13(今天);至今共发布 40 个版本,其中过去 12 个月发布了 24 个;首次发布于 2025/07/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。