# @edicarlos\.lds/businessmap-mcp 中文文档

规范地址：https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/

版本：4\.3\.4
npm 元数据更新时间：2026-11-13T13:13:06.440Z
中文译文更新时间：2026-11-13T06:51:24.585Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40edicarlos.lds/businessmap-mcp
原文对照：https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/?lang=original
项目主页：https://github.com/edicarloslds/businessmap-mcp#readme
源码仓库：https://github.com/edicarloslds/businessmap-mcp

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：695 kB，250 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：6 个
- 首次发布：2025-07-28T18:22:52.375Z
- 最新版本发布：2026-11-13T13:13:05.982Z
- 近 30 天下载量：2242（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 24 个）

## 中文简介

用于 BusinessMap (Kanbanize) 集成的示范背景协议服务器

## 安装

```sh
npm install @edicarlos.lds/businessmap-mcp
```

也可以使用：`pnpm add @edicarlos.lds/businessmap-mcp`、`yarn add @edicarlos.lds/businessmap-mcp`、`bun add @edicarlos.lds/businessmap-mcp`

## README

# BusinessMap MCP 服务器

[![npm version](https://img.shields.io/npm/v/@edicarlos.lds/businessmap-mcp.svg)](https://www.npmjs.com/package/@edicarlos.lds/businessmap-mcp) [![GitHub release](https://img.shields.io/github/v/release/edicarloslds/businessmap-mcp)](https://github.com/edicarloslds/businessmap-mcp/releases) [![npm downloads](https://img.shields.io/npm/dm/@edicarlos.lds/businessmap-mcp)](https://www.npmjs.com/package/@edicarlos.lds/businessmap-mcp) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen)](https://nodejs.org/) [![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![MCP](https://img.shields.io/badge/Model%20Context%20Protocol-000000?logo=anthropic&logoColor=white)](https://modelcontextprotocol.io/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/edicarloslds)](https://github.com/sponsors/edicarloslds)

用于BusinessMap/Kanbanize的模型背景协议(MCP)服务器. 它使AI客户端能够访问BusinessMap工作空间,板子,卡片,用户,自定义字段,工作流程周期数据,资源,以及被引导的提示.

## 你得到的东西

-   默认情况下,有27个面向代理的 MCP 工具,用于高级操作的93个工具全配置
-   直接工作空间、板子和相接卡的6个MCP资源读取
-   4个指导提示,用于董事会分析、报告、卡片制作和工作空间摘要
-   安全探索的可选只读模式
-   `stdio` 为当地MCP客户提供运输,为远程使用提供HTTP运输
-   Docker、结构化记录和方案中间软件支持

见完整目录 [文件/文件](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/TOOLS.md)。 。 。 .

## 快速启动

直接运行 `npx`数字 :

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

或在全球安装:

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

服务器需要Node.js 22或更新.

## 所需的配置

在您的 MCP 客户端、 shell、 部署平台或本地设置这些环境变量 `.env` 文件 :

```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客户端需要相同的指令和环境变量:

```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"
      }
    }
  }
}
```

Claude Desktop、Claude Code、Cursor、VS Code、Windsurf、Zed和其他MCP客户端的客户特有示例在其中 [文档/MCP CLIENTS.md](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/MCP_CLIENTS.md)。 。 。 .

## HTTP 模式

在远程部署服务器或客户端支持可流式HTTP时使用 HTTP 模式:

> **警卫:** HTTP运输无法默认进行认证. 没有TLS、认证、授权,请不要公开披露 限制利率。 见 [程序中间软件](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/MIDDLEWARE.md) 财务报告和审定财务报表 [安全政策](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/SECURITY.md)。 。 。 .

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

配置您的 MCP 客户端 :

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

使用 `/health` 为活生生和 `/ready` 准备 服务器停止 在能力已用尽时接受新会话并关闭活动会话 宽宏大量 `SIGINT` 或者说 `SIGTERM`。 。 。 .

关于自定义认证、授权、记录或费率限制,参见 [文件/MIDLEWARE.md](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/MIDDLEWARE.md)。 。 。 .

## 地方发展

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

创建本地 `.env` 文件 :

```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
```

有用命令 :

```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
```

## 夹克

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

## 解决问题

如果启动失败, 请先检查所需的两个环境变量 :

```bash
echo $BUSINESSMAP_API_URL
echo $BUSINESSMAP_API_TOKEN
```

然后测试 BusinessMap 连接:

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

常见原因:

-   `BUSINESSMAP_API_URL` 未以预期格式 : `https://your-account.kanbanize.com/api/v2`
-   `BUSINESSMAP_API_TOKEN` 缺少、过期或缺少所需权限
-   选中的 MCP 客户端在编辑其配置后尚未完全重新启动

记录详细情况 [文件/记录](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/LOGGING.md)。 。 。 .

## 项目文件

-   [工具、资源和提示](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/TOOLS.md)
-   [MCP 客户端配置](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/MCP_CLIENTS.md)
-   [日志](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/LOGGING.md)
-   [程序中间软件](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/MIDDLEWARE.md)
-   [释放过程](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/docs/RELEASE_PROCESS.md)
-   [脚本](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/scripts/README.md)

## 捐款

见 [捐款额](https://npmcn.com/package/%40edicarlos.lds/businessmap-mcp/CONTRIBUTING.md) 用于本地设置、项目结构和牵引请求指导.

在可能的情况下使用常规承诺:

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

打开拉出请求前 :

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

`npm run test:npx` 是一个可选的API后置烟雾测试,需要BusinessMap证书.

## 支助

关于议题和问题清单:

1.  检查已有 [GitHub 问题](https://npmcn.com/package/issues)
2.  评议 [BusinessMap API 文档](https://businessmap.io/api)
3.  校验您的环境配置
4.  用错误消息、运行时命令和相关 MCP 客户端配置打开新问题

## 相关项目

-   [示范背景协议](https://modelcontextprotocol.io/)
-   [商务地图 API 文档](https://businessmap.io/api)
-   [商业地图Demo API](https://demo.kanbanize.com/openapi#/)
-   [MCP 类型脚本 SDK](https://github.com/modelcontextprotocol/typescript-sdk)

## 发起人

如果这个项目有助于您,请考虑通过 [GitHub 赞助商](https://github.com/sponsors/edicarloslds)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @edicarlos\.lds/businessmap-mcp 是什么？

用于 BusinessMap \(Kanbanize\) 集成的示范背景协议服务器

### 如何安装 @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 和提交记录判断。