BusinessMap MCP 服务器
用于BusinessMap/Kanbanize的模型背景协议(MCP)服务器. 它使AI客户端能够访问BusinessMap工作空间,板子,卡片,用户,自定义字段,工作流程周期数据,资源,以及被引导的提示.
你得到的东西
- 默认情况下,有27个面向代理的 MCP 工具,用于高级操作的93个工具全配置
- 直接工作空间、板子和相接卡的6个MCP资源读取
- 4个指导提示,用于董事会分析、报告、卡片制作和工作空间摘要
- 安全探索的可选只读模式
stdio为当地MCP客户提供运输,为远程使用提供HTTP运输- Docker、结构化记录和方案中间软件支持
见完整目录 文件/文件。 。 。 .
快速启动
直接运行 npx数字 :
npx -y @edicarlos.lds/businessmap-mcp
或在全球安装:
npm install -g @edicarlos.lds/businessmap-mcp
businessmap-mcp
服务器需要Node.js 22或更新.
所需的配置
在您的 MCP 客户端、 shell、 部署平台或本地设置这些环境变量 .env 文件 :
BUSINESSMAP_API_TOKEN=your_token_here
BUSINESSMAP_API_URL=https://your-account.kanbanize.com/api/v2
可选设置 :
| 变量 | 默认 | 说明 |
|---|---|---|
BUSINESSMAP_READ_ONLY_MODE | false | 使用 true 以只注册只读工具. |
BUSINESSMAP_DEFAULT_WORKSPACE_ID | 未设定 | 用于工具的默认工作空间ID . |
BUSINESSMAP_TOOL_PROFILE | essential | 以代理为主的目录 并逐步披露。 使用 full 所有高级行动. |
LOG_LEVEL | 1 | 0 调试, 1 资料, 2 警告你们, 3 错误, 4 无. |
LOG_FORMAT | text | 使用 json 用于结构化日志. |
TRANSPORT | stdio | 使用 stdio 或者说 http。 。 。 . |
PORT | 3000 | HTTP 服务器端口. |
ALLOWED_ORIGINS | http://localhost | HTTP 模式的 CORS 允许列表 . |
ALLOWED_HOSTS | 未设定 | HTTP 模式的主机头允许列表 . |
HTTP_BODY_LIMIT | 1mb | 最大 JSON 请求体积( X)b, (中文(简体) ), kb,或 mb) (中文(简体) ). |
HTTP_MAX_SESSIONS | 100 | 最大同时初始化的 HTTP会话 . |
HTTP_SESSION_TIMEOUT_MS | 1800000 | 以毫秒为间隔会话超时 . |
MCP 客户端设置
大多数MCP客户端需要相同的指令和环境变量:
{
"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"
}
}
}
}
Claude Desktop、Claude Code、Cursor、VS Code、Windsurf、Zed和其他MCP客户端的客户特有示例在其中 文档/MCP CLIENTS.md。 。 。 .
HTTP 模式
在远程部署服务器或客户端支持可流式HTTP时使用 HTTP 模式:
警卫: HTTP运输无法默认进行认证. 没有TLS、认证、授权,请不要公开披露 限制利率。 见 程序中间软件 财务报告和审定财务报表 安全政策。 。 。 .
TRANSPORT=http \
PORT=3000 \
ALLOWED_ORIGINS=https://your-client.example.com \
ALLOWED_HOSTS=your-server.example.com \
npm start
配置您的 MCP 客户端 :
http://your-server:3000/mcp
使用 /health 为活生生和 /ready 准备 服务器停止
在能力已用尽时接受新会话并关闭活动会话
宽宏大量 SIGINT 或者说 SIGTERM。 。 。 .
关于自定义认证、授权、记录或费率限制,参见 文件/MIDLEWARE.md。 。 。 .
地方发展
git clone https://github.com/edicarloslds/businessmap-mcp.git
cd businessmap-mcp
npm install
创建本地 .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
有用命令 :
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
夹克
npm run docker:build
npm run docker:up
npm run docker:logs
npm run docker:down
解决问题
如果启动失败, 请先检查所需的两个环境变量 :
echo $BUSINESSMAP_API_URL
echo $BUSINESSMAP_API_TOKEN
然后测试 BusinessMap 连接:
chmod +x scripts/test-connection.sh
./scripts/test-connection.sh
常见原因:
BUSINESSMAP_API_URL未以预期格式 :https://your-account.kanbanize.com/api/v2BUSINESSMAP_API_TOKEN缺少、过期或缺少所需权限- 选中的 MCP 客户端在编辑其配置后尚未完全重新启动
记录详细情况 文件/记录。 。 。 .
项目文件
捐款
见 捐款额 用于本地设置、项目结构和牵引请求指导.
在可能的情况下使用常规承诺:
feat: add new feature
fix: resolve bug
docs: update documentation
refactor: improve code structure
打开拉出请求前 :
npm run lint
npm test -- --runInBand
npm run build
npm run knip
npm run test:npx 是一个可选的API后置烟雾测试,需要BusinessMap证书.
支助
关于议题和问题清单:
- 检查已有 GitHub 问题
- 评议 BusinessMap API 文档
- 校验您的环境配置
- 用错误消息、运行时命令和相关 MCP 客户端配置打开新问题
相关项目
发起人
如果这个项目有助于您,请考虑通过 GitHub 赞助商。 。 。 .
许可证
麻省理工学院