# @doist/comms-mcp 中文文档

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

版本：10\.2\.1
npm 元数据更新时间：2026-11-11T13:44:15.940Z
中文译文更新时间：2026-11-12T16:17:22.720Z
软件包许可：MIT

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

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

弃用说明：Moved to @todoist/comms-mcp\. Update dependencies and MCP client configs to use @todoist/comms-mcp\.

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

- 包体积（解压后）：405 kB，93 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- peer 依赖：@modelcontextprotocol/server ^2\.2\.0
- 首次发布：2026-05-25T09:43:27.634Z
- 最新版本发布：2026-11-11T11:35:00.105Z
- 近 30 天下载量：2734（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

Doist Commits API 的 MCP 服务器和可导入的 AI 工具

## 安装

```sh
npm install @doist/comms-mcp
```

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

## README

# 发送 MCP 和 AI 工具

MCP服务器和可导入的用于todoist Comms API的AI工具. 使用 工具通过 MCP 服务器,或直接导入以插入通讯 您自己的 AI 对话界面.

## 使用工具

### 1\. 安装

```sh
npm install @doist/comms-mcp
```

### 2\. 将它们插入大赦国际

示例 [Vercel的人工智能SDK](https://ai-sdk.dev/docs/ai-sdk-core/generating-text#streamtext)数字 :

```js
import { fetchInbox, reply, markDone } from '@doist/comms-mcp'
import { streamText } from 'ai'

const result = streamText({
    model: yourModel,
    system: 'You are a helpful Comms assistant',
    tools: {
        fetchInbox,
        reply,
        markDone,
    },
})
```

## 用作 MCP 服务器

### 快开始

```bash
npx @doist/comms-mcp
```

### 设置

#### 克劳德桌面

添加为 `claude_desktop_config.json`数字 :

```json
{
    "mcpServers": {
        "comms": {
            "command": "npx",
            "args": ["-y", "@doist/comms-mcp"],
            "env": {
                "COMMS_API_KEY": "your-comms-api-key-here"
            }
        }
    }
}
```

#### 光标

`~/.cursor/mcp.json` (全球)或 `.cursor/mcp.json` (按项目):

```json
{
    "mcpServers": {
        "comms": {
            "command": "npx",
            "args": ["-y", "@doist/comms-mcp"],
            "env": {
                "COMMS_API_KEY": "your-comms-api-key-here"
            }
        }
    }
}
```

#### 克劳德代码( CLI)

```bash
claude mcp add comms npx @doist/comms-mcp
export COMMS_API_KEY=your-comms-api-key-here
```

#### 视觉工作室代码

1.  命令调色板 — MCP: 添加服务器
2.  配置 :

```json
{
    "servers": {
        "comms": {
            "command": "npx",
            "args": ["-y", "@doist/comms-mcp"],
            "env": {
                "COMMS_API_KEY": "your-comms-api-key-here"
            }
        }
    }
}
```

### 针对非生产部署

默认情况下,服务器会向 `https://comms.todoist.com`。指向 装入或自定义部署,也设定 `COMMS_BASE_URL`数字 :

```json
"env": {
    "COMMS_API_KEY": "your-comms-api-key-here",
    "COMMS_BASE_URL": "https://comms.staging.todoist.com"
}
```

### 获取通讯 API 密钥

通讯接受您的 Todoist API 令牌 。 在 Todoist 中, 打开 **设置 − 集成 – 开发者** 并复制 API 令牌,然后导出为 `COMMS_API_KEY` (或粘入上方的MCP客户端配置). 它已经 完全进入你的账户, 所以保密.

## 特征

这些工具有意采用工作流程形状,而不是1:1包装 环绕 API 端点,所以 LLM 可以用一个 少量电话.

### 可用工具

-   **用户信息** - 关于当前用户的信息,包括其状况
-   **更新用户信息** ——更改用户名称,时区,语言或状态. 该状态与托多主义者(消息、emoji、结束、暂停通知或Karma)共享。 在 OAuth 连接上需要 `user:write` 范围
-   **获取信箱** - 收件箱里的线索和谈话
-   **装入线索** - 用其评论装入一条线索
-   **装入集合** - 装入其信件的对话
-   **搜索内容** 搜索线索、评论和信件的工作空间
-   **获取对象** ——提及当前用户的线索、评论和信件
-   **创建频道** 编号 : **更新频道** ——通过MCP创建或更新工作空间频道
-   **创建图** ——启动新频道线程. 接受可选选项 `displayInInbox` 布尔( 默认) `false`) (中文(简体) ). 何时 `true`,线程在创建后未存档,所以它出现在作者的收件箱中. 另见 [COMMS CREATE THREAD DISPLAY IN-INBOX (英语)](https://npmcn.com/package/%40doist/comms-mcp/#readme-environment-variables)。 。 。 .
-   **更新对象** 编号 : **删除对象** 编辑或删除线索、注释或信件
-   **回复** 对线索或谈话的答复
-   **反应** ——对线索、评论、谈话或消息添加反应
-   **标记** ——将线程或对话标为已读和/或存档
-   **读取标记** 将线程和/或对话标为未存档的已读( 特定 ID, 或工作空间中未读的所有内容)
-   **构建链接** ——将 URL 构建为 Comps 资源
-   **列表** 编号 : **获取组** 编号 : **获取用户** 编号 : **获取工作空间** ——发现帮手

详情见 [斜弧/工具](https://npmcn.com/package/%40doist/comms-mcp/src/tools)。 。 。 .

## 环境变量

| 变量 | 默认 | 说明 |
| --- | --- | --- |
| `COMMS_API_KEY` | _(必须)_ | 您的通讯 API 密钥 . |
| `COMMS_CREATE_THREAD_DISPLAY_IN_INBOX` | `false` | 设定为 `true` 将每个新创建的线程解锁, 这样它就出现在作者的收件箱中, 而无需通过 `displayInInbox: true` 每个电话. **只在本地运行 MCP 时生效 .** 远程/托管的 MCP 中没有此可变集, 并将使用每个调用 `displayInInbox` 参数. |

## 依赖关系

-   MCP 服务器使用正式 [@ modelcontextprotocol/ 服务器](https://github.com/modelcontextprotocol/typescript-sdk)
-   通讯机类型SDK [@ doist/comms-sdk (英语)](https://github.com/Doist/comms-sdk-typescript)

## 地方发展

### 先决条件

-   节点.js 20.18.1+
-   无
-   通讯 API 令牌

### 设置

```bash
git clone https://github.com/todoist/comms-mcp.git
cd comms-mcp
npm install
cp .env.example .env  # then add your COMMS_API_KEY
npm run build
```

### 图标

-   `npm start` - 建立并管理MCP检查员
-   `npm run dev` – 自动重新启动的监视模式
-   `npm test` - 维特
-   `npm run type-check` — 类型脚本
-   `npm run format:check` 编号 : `npm run format:fix` ——克克林特+克克夫克特

### 直接运行单个工具

```bash
npx tsx scripts/run-tool.ts user-info '{}'
npx tsx scripts/run-tool.ts --list
```

## 捐款

1.  考试合格(`npm test`(中文(简体) )
2.  类型`npm run type-check`(中文(简体) )
3.  Lint 格式通过( F)`npm run format:check`(中文(简体) )

使用 [常规武器委员会](https://www.conventionalcommits.org/) —— 说 `feat:`, (中文(简体) ), `fix:`, (中文(简体) ), `docs:`, (中文(简体) ), `test:`, (中文(简体) ), `chore:`。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @doist/comms-mcp 是什么？

Doist Commits API 的 MCP 服务器和可导入的 AI 工具注意：该包已被作者标记为弃用——Moved to @todoist/comms-mcp\. Update dependencies and MCP client configs to use @todoist/comms-mcp\.

### 如何安装 @doist/comms-mcp？

在项目目录运行 npm install @doist/comms-mcp，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@modelcontextprotocol/server（^2\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 comms-mcp，可以用 npx comms-mcp 直接运行。

### @doist/comms-mcp 支持 TypeScript 吗？

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

### @doist/comms-mcp 支持 ESM 还是 CommonJS？

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

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

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

### @doist/comms-mcp 可以商用吗？

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

### @doist/comms-mcp 的下载量有多少？

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

### @doist/comms-mcp 还在维护吗？

最新版本 10\.2\.1 发布于 2026/11/11（2 天前）；至今共发布 38 个版本，其中过去 12 个月发布了 38 个；首次发布于 2026/05/25。作者已将其标记为弃用，新项目建议寻找替代方案。

