# @colada-ag/mcp 中文文档

规范地址：https://npmcn.com/package/%40colada-ag/mcp/

版本：0\.6\.1
npm 元数据更新时间：2026-11-04T12:01:42.640Z
中文译文更新时间：2026-11-14T10:40:14.322Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：231 kB，66 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：4 个
- 首次发布：2026-10-21T14:17:44.147Z
- 最新版本发布：2026-11-04T12:01:42.320Z
- 近 30 天下载量：2070（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

用于 Colada 支持的本地 MCP 服务器: 使用自己的 Colada 登录读取并更改后台数据

## 安装

```sh
npm install @colada-ag/mcp
```

也可以使用：`pnpm add @colada-ag/mcp`、`yarn add @colada-ag/mcp`、`bun add @colada-ag/mcp`

## README

# 科拉达- mcp

Colada支持的本地MCP服务器(VFVE-5977). 它运行在您的笔记本电脑旁边的克洛德桌面,克洛德代码或Cursor,并呼唤Colada后台API,并拥有自己的Colada登录和角色.

工具 :

| 工具 | 它会做什么 |
| --- | --- |
| `list_workspaces` | 列出您可以打开的工作空间. |
| `get_conventions` | 返回 Colada API 常规,该模式在写入前应读取: 呼号、过滤器、修订和更新规则。 没有后端呼叫. |
| `get_api_doc` | 列出带有 API docs 的后台服务以及每个 doc 的一行描述,或者返回一个服务的 OpenAPI YAML 。 描述来自运行时间的后端( Q)`s-ecosystem`; 包没有. |
| `api_get` | 发送一个到后台服务( S)`s-*`)在一个工作空间。 返回状态、 JSON 天体和标题 `Content-Range`, (中文(简体) ), `ETag`, (中文(简体) ), `X-ETag`, (中文(简体) ), `Location`。 。 。 . |
| `api_write` | 发送一个POST,PUT或PATCH与JSON身体. **它改变了数据.** |
| `rtdb_get` | 在一个工作区读取运动实时数据库的一个节点。 可选 `where`, (中文(简体) ), `fields`, (中文(简体) ), `groupBy` 财务报告和审定财务报表 `sum` 在MCP中运行, 准确的总数。 只读一出. |
| `firestore_get` | 阅读一个文档或一个页面的"Firestore运动"集合. 只读一出. |
| `campaigns_budget` | 使用应用程序的规则(储备费、期权、增值税、汇率)计算一个运动项目的预算或报价。 只读一出. |
| `campaigns_add_timesheet_report` | 将一个条目添加到您自己的“运动”计时表,并在预算行中复制. **它改变了数据.** |
| `campaigns_update_timesheet_report` | 修改或移动您自己的时间表条目及其预算副本. **它改变了数据.** |
| `campaigns_create_offer` | 创建“运动”提议,可选从领先者获得. **它改变了数据.** |
| `campaigns_update_offer` | 更改一个要约的设置 . **它改变了数据.** |
| `campaigns_create_lead` | 在管道中创建线索 。 需求 `COLADA_ALLOW_PERSONAL_DATA=true`。 。 。 . **它改变了数据.** |
| `campaigns_add_budget_rows` | 将知识库,免费和分组列加到要约预算并重算其总额. **它改变了数据.** |
| `logout` | 结束存储的会话. |

> **0.3.0中突破变化.** 输入的读取工具 `list_events`, (中文(简体) ), `get_event`, (中文(简体) ), `list_email_templates`, (中文(简体) ), `get_email_template` 财务报告和审定财务报表 `get_registration_form` 被删除。 使用 `api_get` 相反( 读取服务文件 ) `get_api_doc` (第一编) 服务器不再只读.

## 安装

你只需要20个节点 总是使用准确的版本,如下. 要更新, 请故意更改配置中的版本 .

### 克劳德桌面

打开设置 – 开发者 – 编辑配置并添加到 `claude_desktop_config.json`数字 :

```json
{
  "mcpServers": {
    "colada": {
      "command": "npx",
      "args": ["-y", "@colada-ag/mcp@0.3.0"]
    }
  }
}
```

重新启动克洛德桌面.

### 克劳德代码

```bash
claude mcp add colada -- npx -y @colada-ag/mcp@0.3.0
```

### 光标

打开光标设置 → MCP → 添加新的全局 MCP 服务器,或编辑 `~/.cursor/mcp.json`数字 :

```json
{
  "mcpServers": {
    "colada": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@colada-ag/mcp@0.3.0"]
    }
  }
}
```

使用全局 `~/.cursor/mcp.json`,不是项目 `.cursor/mcp.json`在光标设置中 → MCP, `colada` 必须启用并显示5个工具。 如果失败 `spawn npx ENOENT`,光标找不到 `npx` (例如使用 nvm): 将完整路径从 `which npx` 输入 `command`。 。 。 .

保持隐私模式(设置 一般 隐私),不为这些工具启动自动运行.

## 主机和域

`COLADA_HOSTS` 是一个以逗号分隔的后台主机名列表, 不包含 `https://`默认为 `admin.colada365.com`添加到 `env` 在上述配置中,例如舞台:

```json
"env": { "COLADA_HOSTS": "stage-admin.colada365.com" }
```

在克洛德代码中:

```bash
claude mcp add colada --env COLADA_HOSTS=stage-admin.colada365.com -- npx -y @colada-ag/mcp@0.3.0
```

服务器从主机的公共后台配置读取每个主机的Keycloak域. 一个王国的托肯只归它自己的宿主.

在一个主机下,工具没有域参数. 有几个主机, 例如 `admin.colada365.com,<customer host>`,工具得到一个 `realm` 参数。 没有它,他们使用第一宿主的地盘。 每个主机必须有自己的域.

旧的 `COLADA_ENV` 设置不再使用。 如果设置了, 服务器会以出错停止 .

## 书写和批准

`api_write` 标记为破坏性工具,所以客户在每次通话前都会询问您。 在批准前读取请求(方法,路径,正体).

> **不选择“ 永远允许 ” `api_write`。 。 。 .** 之后客户端发送出每封信而不询问您,也写出模型编造或错误. 你是唯一的检查模型 和客户的数据.

MCP在发送任何信息之前拒绝一些请求,无论你的角色允许什么:

-   每一个 HTTP `DELETE`,以及删除数据的固定路由列表(bulk PATCH并删除任务);删除数据保留手动后台动作;
-   读取或更改机密的路径(SMTP、花纹、火地信号、密码和检察官办公室重置);
-   CONSR服务`s-consr-*`),外部路径 `/api/`,以及除 `Range` 财务报告和审定财务报表 `If-Match`。 。 。 .

## 个人资料

持有个人数据(客人、联系人、用户、演讲者、发票、付款、电子邮件等)的服务默认关闭;混合服务的几条路线仍然开放(例如工作空间设置和文件模板)。 要打开它们,设置 `COLADA_ALLOW_PERSONAL_DATA=true` 内 `env` 并重新启动客户端 :

```json
"env": { "COLADA_ALLOW_PERSONAL_DATA": "true" }
```

只有准确的值 `true` 打开它。 只有在任务需要个人数据时才打开,然后再次关闭.

## 运动(火器基地)

运动数据不是在后台API,而是在Firebase. `rtdb_get`, (中文(简体) ), `firestore_get` 财务报告和审定财务报表 `campaigns_budget` 只读取。 Firebase工具从不叫"云函数".

-   服务器获得一个 Firebase 令牌, 上面有您自己的 Colada 登录, 用于呼叫的工作空间 。 令牌留在内存中而不被存储; Firebase 访问以您的 Colada 会话结束 .
-   您可以看到 Campaigns app 所显示的内容 : MCP 检查您每个数据节点的 Campaign 权限, 当您只有 “ 自己的时间表 ” 访问权限时, 只保留您自己的时间表行, 而忽略您可能看不到的项目 .
-   个人数据(例如计时表描述、项目人员、联系人、聊天、账户)将被删除,除非 `COLADA_ALLOW_PERSONAL_DATA=true`秘密永远不会被归还.

### 运动写道:

六个 `campaigns_*` 工具更改实时数据库中的“运动”数据:计时表条目、提议、线索和预算行。 每个都写着与Campaigns应用中的匹配动作相同的节点和字段.

-   他们需要你的竞选许可 行动,如应用程序。 计时表工具只更改自己的条目 .
-   `owner` 其他用户字段总是您。 没有删除和撤销.
-   工作区必须存在您通过的文件(项目、行、提议、领导、成本中心、知识基础项目、单位),否则什么都不写.
-   个人字段(例如,计时表描述或主名)仅被接受 `COLADA_ALLOW_PERSONAL_DATA=true`。 。 。 .
-   保留了别人在读写之间的变化:工具再次读取并应用到上方,最多3次.
-   工具只写入您工作空间下方路径的允许列表, 绝不 `projects/`。 。 。 .
-   每一个写作都会在调用日志中获得自己的行号,没有身体.

## 登录

第一个工具调用打开浏览器中的 Colada 登录 。 登入,然后请克洛德重试. 会话保存在OS键链中( service) `colada-mcp`)并持续约一个工作日,同样在重启之后.

每个域都有自己的登录. 与另一个域的第一个呼叫打开了该域主机上的第二个浏览器登录. 和你自己的用户一起登记.

要结束会议,请克劳德打电话 `logout`数个主机和无域,它从所有域中日志出.

## 调用日志

每个工具呼叫都写出一行 `~/.colada-mcp/calls.log`: 时间、域、用户、工作空间、工具、 HTTP 状态以及用于 `get_api_doc`, (中文(简体) ), `api_get` 财务报告和审定财务报表 `api_write` 以及方法、服务、路径、查询和是否 `If-Match` 被发送。 对于Firebase工具,它持有应用程序、存储、路径和查询选项; `where` 在没有其值的情况下登录。 这个 `campaigns_*` 写入工具每 Firebase 写入一行( 方法、 路径、 重试、 HTTP 状态) ; 拒绝写入有 HTTP 状态 `null`。日志中从未包含符号、请求或响应机构,或标题值。 查询值按给定记录, 因此在一个人的电子邮件上会出现过滤器 .

## 数据和隐私

服务器只能读取和更改您的 Colada 用户可能读取和更改的内容 。 但是,每个工具的答案都成为了AI聊天的一部分,并被发送到Anthropic(Cursor: to Cursor and the model professor served there). 只询问您需要的客户数据 .

## 地方发展

```bash
npm ci
npm run build
npm test
npx biome check .
```

将本地建筑添加到 Claude Code 中:

```bash
claude mcp add colada -- node /path/to/colada-mcp/dist/index.js
```

## 释放

仅由 npm 发布 `publish.yml` 工作流程,通过 npm 信任的发布(无 npm 令牌). 设置新版本为 `package.json`合并到 `master`标记 `v<version>`。 。 。 .

## 常见问题

### @colada-ag/mcp 是什么？

用于 Colada 支持的本地 MCP 服务器: 使用自己的 Colada 登录读取并更改后台数据

### 如何安装 @colada-ag/mcp？

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

### @colada-ag/mcp 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/colada-ag\_\_mcp 是否存在。

### @colada-ag/mcp 支持 ESM 还是 CommonJS？

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

### @colada-ag/mcp 需要什么版本的 Node\.js？

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

### @colada-ag/mcp 可以商用吗？

@colada-ag/mcp 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @colada-ag/mcp 的下载量有多少？

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

### @colada-ag/mcp 还在维护吗？

最新版本 0\.6\.1 发布于 2026/11/04（9 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。