Skip to main content
Glama
evlon

codebuddy-matrix-channel

by evlon

codebuddy-matrix-channel

Мост для подключения Matrix к локальной сессии CodeBuddy Code (https://cnb.cool/codebuddy/codebuddy-code) через Channel-плагин (MCP-сервер).

Эффект аналогичен встроенным каналам CodeBuddy для Telegram / Discord / WeChat:

  • Сообщение в комнате Matrix → появляется в сессии CodeBuddy в виде #matrix · @alice:matrix.org: привет

  • Ответы CodeBuddy отправляются обратно в комнату Matrix через инструмент reply

  • Опционально: запросы на разрешение от CodeBuddy пересылаются в «контрольную комнату», где можно одобрить/отклонить вызовы инструментов с телефона

Этот плагин основан на механизме расширения Channel от CodeBuddy (см. docs/cn/cli/channels.md и channels-reference.md), без изменения самого CodeBuddy.


1. Принцип работы

Matrix 房间  ──(matrix-js-sdk 收消息)──▶  matrix-channel (本插件)
                                              │  notifications/claude/channel
                                              ▼
                                        CodeBuddy Code 会话
                                              │  reply 工具 / 权限请求
                                              ▼
                                        matrix-channel ──(sendText)──▶ Matrix 房间

Плагин запускается CodeBuddy как дочерний процесс через stdio и общается по протоколу MCP.


Related MCP server: mcacp

2. Установка

cd matrix-channel
npm install
npm run build        # 编译到 dist/(也可直接用 tsx 运行,无需构建)

Для работы требуется Node >= 20.


2.1 Быстрый старт (цифровой аватар)

  1. Установка / сборка

    cd matrix-channel && npm install && npm run build
  2. Заполните .env (минимальный рабочий набор, см. раздел 3)

    MATRIX_HOMESERVER=https://im.yiq.pub
    MATRIX_ACCESS_TOKEN=<从 Element:设置 → 帮助 → 高级 → 访问令牌 复制>
    MATRIX_USER_ID=@evlon-ai:im.yiq.pub
    MATRIX_ALLOWLIST=@evlon:im.yiq.pub           # 防 prompt 注入,必填
    MATRIX_OWNER_ID=@evlon:im.yiq.pub            # 分身管理者=你,审批权只认此身份
    MATRIX_CONTROL_ROOM_ID=!<控制室房间ID>:im.yiq.pub
    MATRIX_MENTION_REQUIRED=true                 # 群里只响应 @分身
    # 可选:MATRIX_TRUSTED_SENDERS / MATRIX_TRUSTED_ROOMS / MATRIX_AUTHORIZED_WORK
  3. Самопроверка (запускайте после каждого изменения .env)

    npm run doctor      # 期望:连接 ✅、账号 ✅、E2EE ✅
  4. Подключение к CodeBuddy: зарегистрируйте в .mcp.json проекта (абсолютный путь) и запустите

    codebuddy --channels server:matrix --dangerously-load-development-channels
  5. Повседневное использование

    • В группе @упомяните аватара для поручения → доверенные источники/авторизованные задачи выполняются автоматически; незнакомые задачи сначала выводят план и отправляют в контрольную комнату для вашего approve.

    • Инструменты с высоким риском (Bash/запись файлов и т.д.) всегда запрашивают разрешение в контрольной комнате.

    • Ваши команды в контрольной комнате (распознаётся только MATRIX_OWNER_ID):

      • approve (run / go, можно с ID комнаты) → авторизовать задачу в этой комнате

      • yes <id> / no <id> → разрешить / отклонить ожидающие запросы на высокорисковые разрешения

Для зашифрованных комнат нужен MATRIX_E2EE=true; если MATRIX_DEVICE_ID оставить пустым, он будет автоматически выбран из /devices; при ошибке укажите ID устройства из «Настройки → Устройства».


3. Конфигурация

Скопируйте .env.example в .env и заполните:

cp .env.example .env

Переменная

Описание

MATRIX_HOMESERVER

Адрес домашнего сервера, например https://matrix.org (обязательно)

MATRIX_ACCESS_TOKEN

access_token аккаунта (рекомендуется; скопируйте из Element «Настройки → Справка»)

MATRIX_USER_ID

Необязательно, для распознавания «своих сообщений», например @alice:matrix.org

MATRIX_USER / MATRIX_PASSWORD

Альтернативный способ аутентификации, при запуске выполняется loginWithPassword для получения токена

MATRIX_ALLOWLIST

Разрешённые отправители сообщений (ID пользователей), через запятую (обязательно)

MATRIX_ROOM_ALLOWLIST

Разрешённые ID комнат для прослушивания, через запятую (пусто = все)

MATRIX_CONTROL_ROOM_ID

ID контрольной комнаты для ретрансляции разрешений (необязательно, но для режима цифрового аватара обязательно)

MATRIX_OWNER_ID

Matrix ID пользователя-владельца (owner) аватара (обязательно). Право одобрения признаётся только за этим ID

MATRIX_TRUSTED_SENDERS

ID доверенных коллег, через запятую; их задачи выполняются автоматически (безопасные инструменты)

MATRIX_TRUSTED_ROOMS

ID доверенных групп, через запятую; все задачи в этих комнатах выполняются автоматически

MATRIX_AUTHORIZED_WORK

Описание авторизованных обычных задач (произвольный текст), чтобы аватар различал «обычные vs незнакомые»

MATRIX_MENTION_REQUIRED

Отвечать ли в группах только на сообщения с @упоминанием (по умолчанию true; рекомендуется при нескольких аватарах)

MATRIX_HIGH_RISK_TOOLS

Список инструментов с высоким риском, через запятую; по умолчанию Bash,Write,Edit,MultiEdit,NotebookEdit

MATRIX_DOWNLOAD_MEDIA

Скачивать ли изображения/файлы локально и вставлять как [file: путь] (по умолчанию false)

MATRIX_MEDIA_DIR

Каталог для загрузки медиа (по умолчанию .matrix-media)

MATRIX_E2EE

Включить ли сквозное шифрование (по умолчанию false, см. раздел 6 ниже)

MATRIX_CRYPTO_DB

В matrix-js-sdk 42.x не действует (см. раздел 6): Rust crypto работает через wasm + fake-indexeddb (память), ключи не сохраняются на диск. Можно оставить пустым

⚠️ Безопасность: обязательно настройте MATRIX_ALLOWLIST (проверка по отправителю, а не по комнате, чтобы любой участник группы не мог внедрить сообщения в сессию). Пустое значение разрешает всем, только для локального тестирования.


4. Подключение к CodeBuddy

Способ A: на этапе разработки (в обход белого списка маркета)

Зарегистрируйте этот плагин в .mcp.json вашего проекта CodeBuddy:

{
  "mcpServers": {
    "matrix": {
      "command": "npx",
      "args": ["tsx", "/绝对路径/matrix-channel/src/index.ts"]
    }
  }
}

Затем запустите CodeBuddy:

codebuddy --channels server:matrix --dangerously-load-development-channels

После сборки можно запускать через node:

"args": ["node", "/绝对路径/matrix-channel/dist/index.js"]

Способ B: упаковка как плагин (после публикации в официальный маркет)

npm run build

Затем опубликуйте codebuddy-matrix-channel как плагин и используйте:

codebuddy --channels plugin:matrix-channel@<你的市场>

5. Использование

  1. После запуска отправьте сообщение в разрешённую комнату Matrix — в сессии CodeBuddy появится #matrix · @вы: ...

  2. Когда CodeBuddy завершит обработку, ответ появится в комнате Matrix

  3. Если настроен MATRIX_CONTROL_ROOM_ID: при вызове CodeBuddy инструментов, требующих одобрения (Bash / Write и т.д.), в контрольную комнату отправляется уведомление (как системное m.notice, без триггера непрочитанных/уведомлений). Ответьте yes <id> для разрешения / no <id> для отклонения

Параметры инструмента reply

Параметр

Описание

chat_id

ID комнаты Matrix (берётся из атрибута chat_id метки сообщения в сессии)

text

Текст для отправки

html

Необязательно, HTML-содержимое (отправляется вместе с text, в формате org.matrix.custom.html)

msgtype

Необязательно, m.text (по умолчанию, обычное сообщение) или m.notice (системное: не вызывает непрочитанные/уведомления/оповещения в клиенте)

Например, попросите CodeBuddy ответить статусным сообщением через m.notice: reply({ chat_id: "!abc:server", text: "обработано", msgtype: "m.notice" }).

Инструмент health_check

Можно вызвать напрямую в сессии CodeBuddy или через проверку здоровья /mcp; эквивалентен части npm run doctor по проверке связи/E2EE, возвращает JSON:

{ "ok": true, "userId": "@alice:matrix.org", "e2ee": true, "cryptoReady": true }

При ok=false добавляется поле error с описанием причины (соединение/аутентификация/инициализация E2EE).


6. Ограничения и примечания

  • Комнаты со сквозным шифрованием (E2EE): по умолчанию поддерживаются только незашифрованные комнаты. Для моста в зашифрованные комнаты установите MATRIX_E2EE=true; плагин использует встроенный Rust crypto от matrix-js-sdk (initRustCrypto), SDK автоматически выполняет «расшифровку при получении, шифрование при отправке» — не нужно реализовывать протокол шифрования самостоятельно. После включения:

    • Зашифрованные сообщения приходят как m.room.encrypted, SDK расшифровывает их (после Event.decrypted тип становится реальным), затем плагин передаёт их в сессию;

    • Ответы в зашифрованные комнаты автоматически шифруются SDK;

    • Хранение ключей (важно, зависит от версии): в matrix-js-sdk 42.x у Rust crypto есть только реализация wasm/IndexedDB (@matrix-org/matrix-sdk-crypto-wasm), нет нативного Node-бэкенда. Чтобы это работало в Node, плагин при запуске внедряет глобальный indexedDB через fake-indexeddb/auto — этот полифилл чисто в памяти, поэтому:

      • Ключи существуют только в памяти процесса, MATRIX_CRYPTO_DB в этой версии не создаёт реальный файл SQLite на диске; после перезапуска процесса ключи нужно пересогласовывать (не влияет на приём/отправку, просто требуется повторная пересылка ключей/проверка устройств).

      • Настоящее дисковое хранение требует обновления до версии matrix-js-sdk с нативным бэкендом @matrix-org/matrix-sdk-crypto-nodejs или будущей версии с поддержкой nodejs-входа (тогда можно убрать полифилл fake-indexeddb и использовать нативный бэкенд).

      • Обратите внимание: установленный в зависимостях @matrix-org/matrix-sdk-crypto-nodejs в текущей версии 42.2.0 не вызывается SDK, он лишь запасной вариант для будущего обновления; сейчас шифрование работает через wasm + полифилл fake-indexeddb в памяти.

    • При первом входе нового устройства в зашифрованную комнату рекомендуется проверить устройство этого бота в Matrix-клиенте (иначе собеседник может видеть предупреждение «непроверенное устройство», но сообщения всё равно будут приниматься/отправляться).

  • Медиа: по умолчанию в сессию передаётся только текст сообщения; при включении MATRIX_DOWNLOAD_MEDIA изображения/файлы скачиваются локально и вставляются как [file: путь], чтобы агент мог их прочитать.

  • Ретрансляция разрешений зависит от возможности claude/channel/permission в CodeBuddy; если версия CodeBuddy не поддерживает её, основной мост чата не затрагивается.


7. Цифровой аватар: модель авторизации владельца (основной сценарий)

Воспринимайте аватара как «коллегу в группе», которого можно свободно @упоминать для поручений, но он не изменит ничего по-настоящему, пока владелец не согласится.

Сценарий

  • Коллеги создают несколько групп (например, #ПроектA, #Поддержка), в группах может быть несколько ботов-аватаров. Коллеги в группе @упоминают вашего аватара для поручений; он отвечает только при @упоминании (в личке отвечает всегда).

  • После получения поручения:

    • Обычные / авторизованные задачи (от ваших предустановленных MATRIX_TRUSTED_SENDERS / MATRIX_TRUSTED_ROOMS, или входящие в описание MATRIX_AUTHORIZED_WORK) → выполняются автоматически (безопасные инструменты).

    • Незнакомые задачи (вне авторизованного диапазона) → аватар сначала составляет план, вызывает request_approval для эскалации в вашу контрольную комнату; вы отвечаете approve — только тогда выполняется.

    • Высокорисковые операции (MATRIX_HIGH_RISK_TOOLS, например Bash / запись файлов) → всегда запрашивают ваше разрешение, независимо от источника.

Архитектурные уровни

  • MCP-плагин = безопасная передача + жёсткий шлюз (кодом, не доверяя модели): фильтр @, решение о разрешении allow/deny основывается только на проверяемых фактах (является ли owner, доверенный ли источник, высокорисковый ли инструмент), одобрение в контрольной комнате признаётся только за MATRIX_OWNER_ID.

  • SKILL = стратегический мозг (семантическое суждение, передаётся агенту): skills/matrix-avatar/SKILL.md направляет аватара в определении «обычное vs незнакомое», при незнакомом переходит в режим плана и вызывает request_approval. Агент только запрашивает одобрение, никогда не разрешает сам; разрешение исходит только из «предустановленных доверенных источников владельца» или «approve владельца».

Встроенные channel instructions плагина уже содержат эту стратегию, поэтому работа возможна и без дополнительной установки SKILL; skills/matrix-avatar/SKILL.md предоставляется для повторного использования/настройки в CodeBuddy.

Три уровня состояния задач (по комнатам)

Состояние

Значение

Безопасные инструменты

Высокорисковые инструменты

approved

Доверенный источник / уже approve

Автоматическое выполнение

Запрос владельцу (контрольная комната yes)

pending

Эскалировано на рассмотрение (request_approval)

Блокировка

Блокировка

unauthorized

Незнакомый источник без авторизации

Блокировка

Блокировка (и подсказка approve)

Команды контрольной комнаты (действуют только для владельца MATRIX_OWNER_ID)

  • approve (или run / go, можно с ID комнаты, например approve !projectA:server) → авторизовать текущую задачу в этой комнате, аватар начинает выполнение.

  • yes <id> / no <id> → разрешить / отклонить ожидающие высокорисковые запросы на разрешение.

  • Ответы других пользователей в контрольной комнате игнорируются.

Пример конфигурации (.env)

MATRIX_OWNER_ID=@you:matrix.org
MATRIX_TRUSTED_SENDERS=@alice:matrix.org,@bob:matrix.org
MATRIX_TRUSTED_ROOMS=!projectA:server
MATRIX_AUTHORIZED_WORK=回答产品问题、总结会议纪要、起草文档
MATRIX_MENTION_REQUIRED=true
MATRIX_HIGH_RISK_TOOLS=Bash,Write,Edit,MultiEdit,NotebookEdit

8. Самопроверка (doctor)

После заполнения .env можно запустить самопроверку для подтверждения конфигурации, связи и состояния E2EE, а затем запустить CodeBuddy:

npm run doctor

Самопроверка выводит текущую конфигурацию (токен маскируется), проверяет доступность homeserver и действительность учётных данных, а при MATRIX_E2EE=true пытается инициализировать Rust crypto. Любая ошибка даёт явную причину и завершается ненулевым кодом выхода.


9. Структура каталога

matrix-channel/
├── src/
│   ├── config.ts     # 环境变量 / 白名单 / 授权配置读取与校验
│   ├── matrix.ts     # Matrix 客户端封装(连接、@提及过滤、收/发、下载媒体、E2EE、自检)
│   ├── index.ts      # MCP 服务:channel 通知、授权硬闸、reply / request_approval 工具、控制室审批
│   └── doctor.ts     # `npm run doctor` 自检入口
├── skills/
│   └── matrix-avatar/
│       └── SKILL.md  # 分身行为策略(语义判断:常用 vs 陌生)
├── package.json
├── tsconfig.json
├── .gitignore
├── .env.example
└── README.md

Available Tools

6 tools
health_checkA

运行连接/E2EE 自检(等价于 npm run doctor),返回 Matrix 连接与加密状态。可在 /mcp 健康检查中调用。

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses that the tool performs a diagnostic self-check and returns connection and encryption status, which implies a read-only probe. It does not explicitly say it has no side effects, but the self-check framing makes the behavior sufficiently transparent for a zero-parameter tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one compact sentence that front-loads the action and scope, then adds the return value and invocation context. Every clause earns its place; there is no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple zero-parameter diagnostic tool with no output schema, the description covers purpose, method, return value, and invocation context. Nothing essential is missing for an agent to select and call the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has no parameters and schema description coverage is 100%, so there is nothing for the description to clarify. Baseline for zero parameters is 4, and the description adds no conflicting or misleading parameter information.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource: it runs a connection/E2EE self-check equivalent to 'npm run doctor' and returns Matrix connection and encryption status. It also distinguishes this health-check tool from the messaging/approval-oriented sibling tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear usage context by stating it can be invoked during /mcp health checks and is for checking connection/encryption status. It does not explicitly name when-not-to-use conditions, but the sibling tools are clearly different in purpose, so the distinction is implicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_roomsA

列出本分身已加入的所有 Matrix 房间(room_id + 标题),用于了解「我在哪些房间 / 群」。当不知道该回哪个房间时,可据此找到与管理者(owner)的私聊房间。

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and discloses the scope (only rooms the avatar has joined) and the output content (room_id + title). For a read-only, zero-parameter listing tool this is adequate, though it omits minor traits like ordering, pagination, and whether the owner room is guaranteed to exist.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with zero filler. The first sentence front-loads the core purpose and output fields; the second adds a practical decision aid without repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple 0-parameter list tool with no output schema, the description covers what is listed, what fields come back, and when to use it. Minor gaps (e.g., behavior when no rooms exist, pagination) are low-stakes for a read-only listing, so nothing critical is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so schema coverage is trivially 100% and there is nothing to document. The baseline of 4 applies because no parameter semantics are needed; the description appropriately spends its effort on output and scope instead.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb (列出/list) and resource (all Matrix rooms this avatar has joined), and explicitly states the returned fields (room_id + title). The scope '本分身已加入' clearly separates it from per-room siblings like room_info and room_members, so an agent can tell them apart without opening another schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides a concrete usage scenario: when unsure which room to reply to, use this tool to locate the owner's private chat room. It does not, however, name alternatives or state when not to use it (e.g., room_info for a single room's details), so it lacks explicit exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

replyA

通过 Matrix 把回复发送到指定房间(chat_id)。省略 chat_id 时回复发往最近一次转发进来的房间(原路返回)。发送会按配置自动重试;若多次仍发不回来源房间,则改用默认回复(MATRIX_DEFAULT_REPLY)发往控制室/owner 私聊兜底。

ParametersJSON Schema
NameRequiredDescriptionDefault
htmlNo可选,HTML 格式正文(与 text 同时发送)
textYes要发送的文本
chat_idNoMatrix 房间 ID,例如 !abc:server。省略时回复发往最近一次转发进来的房间。
msgtypeNo消息类型:m.text 普通消息;m.notice 系统提示(不触发未读/提醒)

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

没有 annotations,因此描述承担了全部行为披露责任。描述主动说明了自动重试机制、失败后的默认回复兜底行为(发往控制室/owner 私聊),以及原路返回的逻辑,这些都是非显而易见的关键行为。

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

描述短小精悍,三句话分别说明核心操作、chat_id 省略行为和重试/兜底机制,信息密度高且没有冗余。关键行为前置,结构清晰。

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

对于发送消息类工具,描述配合完整 schema 已覆盖调用所需信息:目标房间、默认回退行为、重试和失败兜底。没有输出 schema 也不影响理解,整体上下文完整。

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema 描述覆盖率为 100%,所有参数在 schema 中已有说明。描述额外强调了 chat_id 省略时的行为,但 schema 中同样包含该信息,因此描述在参数语义上未显著超出 schema 提供的价值。

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

描述明确说明该工具通过 Matrix 发送回复到指定房间,并解释了省略 chat_id 时的原路返回行为。动词和资源都很具体,与 list_rooms、room_info 等只读查询类兄弟工具形成清晰区分。

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

描述清晰说明了何时使用该工具(发送回复)以及省略 chat_id 时的行为,但未明确提及何时不应使用或列举替代工具。整体使用场景清楚,只是缺少显式的排他性说明。

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

request_approvalA

当判断当前任务来自陌生来源或含高风险时调用,把任务升级到管理者控制室等待审批。管理者回复 approve 后任务会被重放并执行。

ParametersJSON Schema
NameRequiredDescriptionDefault
reasonYes需要审批的原因/计划摘要

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains that the task is escalated, that it waits for approval, and that it will be replayed and executed after the manager replies 'approve'. It does not mention rejection behavior, but the core lifecycle is clearly disclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one concise sentence that front-loads the trigger condition, then states the action and outcome. Every part is informative and there is no redundant wording.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with a single required parameter and no output schema, the description covers the key context: when to call, what happens, and what triggers execution. It does not specify behavior on rejection, but the overall guidance is sufficient for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already covers the single parameter 'reason' with 100% coverage, including its meaning as the approval reason or plan summary. The description adds no further parameter-level detail, so the baseline score of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies a specific action: escalating the current task to a manager control room for approval. It also gives the triggering condition ('unfamiliar source or high risk'), which distinguishes it from the sibling tools like reply, health_check, and list_rooms.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool: when the task is from an unfamiliar source or carries high risk. It does not explicitly list alternatives or exclusions, but the condition is clear enough that an agent can decide appropriately.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

room_infoA

获取指定 Matrix 房间(群/私聊)的可读信息:名称、主题、成员昵称与 ID。用于配置与检查「房间 ID ↔ 名称」映射。chat_id 省略时取最近一次转发进来的房间。

ParametersJSON Schema
NameRequiredDescriptionDefault
chat_idNoMatrix 房间 ID,例如 !abc:server。省略时取最近对话房间。

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the behavioral disclosure burden. It does disclose that the operation retrieves readable info and defines the default behavior when chat_id is omitted, which is useful. However, it does not explicitly state that the operation has no side effects, what happens on invalid room IDs, or any permission requirements — gaps that matter for a tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no filler. The first sentence states the tool's purpose and outputs, the second gives the use case and default behavior. Critical information is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple getter with one optional parameter, the description is mostly complete: it lists return fields, the use case, and the fallback behavior. Since there is no output schema, describing the expected fields is important and done here. Minor omissions around error/not-found behavior prevent a 5.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value beyond the schema by clarifying that 'recent conversation' specifically means the most recently forwarded room, and by explaining why chat_id is optional in terms of the mapping use case.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description specifies a clear verb ('获取' / get) and resource ('指定 Matrix 房间'), and lists the exact data returned (name, topic, member nicknames and IDs). It does not explicitly contrast itself with siblings such as list_rooms or room_members, but the resource scope and output fields are specific enough to distinguish it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description states a concrete use case: configuring and checking the 'room ID ↔ name' mapping. It also explains the optional chat_id behavior (fallback to the most recently forwarded room), which guides when to call the tool without an argument. No alternatives or when-not-to-use conditions are mentioned, hence not a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

room_membersA

获取指定 Matrix 房间(群聊)的在场成员列表,返回每个成员的 user_id 与 display_name,用于了解「谁在场」。chat_id 省略时取最近一次转发进来的房间。

ParametersJSON Schema
NameRequiredDescriptionDefault
chat_idNoMatrix 房间 ID,例如 !abc:server。省略时取最近对话房间。

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

无 annotations,描述承担行为说明职责。它说明了工具是只读查询、返回成员列表并解释 chat_id 缺省行为,但未披露任何可能的权限要求、失败情形或数据即时性等行为特征。

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

两句话完整说明用途、返回值与缺省行为,信息密度高且无冗余,属于精炼的合格描述。

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

对单参数只读列表工具,描述已说明返回字段、缺省行为和使用场景;缺少输出结构样例或错误条件,但整体足以让 agent 正确调用。

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

参数仅有 chat_id,schema 已包含描述;描述额外说明了省略 chat_id 时的默认行为(取最近对话房间),为参数语义增加了超出 schema 的价值。

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

描述使用明确动词「获取」与资源「指定 Matrix 房间(群聊)的在场成员列表」,并具体说明返回 user_id 与 display_name,足以与 siblings 如 list_rooms、room_info 区分。

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

描述说明 chat_id 省略时取最近转发进来的房间,提供了明确的使用上下文;但未明确说明何时不使用本工具(例如需要房间详情时用 room_info),因此未达满分。

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 6 tool updatesv0.1.0
    • First observedhealth_check
    • First observedlist_rooms
    • First observedreply
    • First observedrequest_approval
    • First observedroom_info
    • First observedroom_members

TDQS

A4.1/5.0

Scored across 6 tools

Disambiguation4/5

The tools are mostly distinct: reply, health_check, request_approval, list_rooms, room_members, and room_info each target a different action or resource. The only mild overlap is between room_info and room_members, since room_info also includes member names/IDs, but the descriptions are clear enough to guide selection.

Naming Consistency3/5

All names are lowercase snake_case, but the semantic pattern is mixed: reply is a bare verb, list_rooms and request_approval are verb+noun, while room_members and room_info are noun+noun descriptors. This is readable but not consistently a verb_noun convention.

Tool Count5/5

Six tools is a tight, well-scoped set for a Matrix channel bridge. Each tool supports a distinct part of the workflow—responding, verifying health, escalating approval, and discovering rooms and participants—without redundancy or bloat.

Completeness4/5

The set covers the core bot workflow on a Matrix channel: replying, understanding room context, checking connection health, and handling approval escalation. Minor gaps like joining/leaving rooms or reading message history exist, but they are outside the apparent core purpose and do not create dead ends.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers