# @bigbrain-work/mcp-connect 中文文档

规范地址：https://npmcn.com/package/%40bigbrain-work/mcp-connect/

版本：1\.4\.1
npm 元数据更新时间：2026-10-28T13:52:39.316Z
中文译文更新时间：2026-11-08T02:32:48.586Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：249 kB，44 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.14\.1
- 运行依赖：11 个
- 首次发布：2026-07-30T11:29:12.825Z
- 最新版本发布：2026-10-28T13:52:38.918Z
- 近 30 天下载量：2295（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 27 个）

## 中文简介

石榴 AI 官方 CLI：登录、配置 Agent、检查 MCP 状态并桥接远程工具。

## 安装

```sh
npm install @bigbrain-work/mcp-connect
```

也可以使用：`pnpm add @bigbrain-work/mcp-connect`、`yarn add @bigbrain-work/mcp-connect`、`bun add @bigbrain-work/mcp-connect`

## README

# @bigbrain-work/mcp-connect

石榴 AI 官方命令行工具。它负责验证当前凭据、配置常见 Agent、检查远程 MCP、读取实时工具清单，并为只支持 stdio 的客户端提供桥接。

## 命令

```bash
# 微信扫码登录；令牌进入操作系统凭据库
npx -y @bigbrain-work/mcp-connect login

# Agent/无头环境：展示二维码后立即按返回间隔短轮询，不等待用户回复
npx -y @bigbrain-work/mcp-connect login --no-wait --json
npx -y @bigbrain-work/mcp-connect login poll --session <会话号> --json

# 自动检测并配置已安装的 Agent
npx -y @bigbrain-work/mcp-connect install

# 只配置一个 Agent
npx -y @bigbrain-work/mcp-connect install --agent codex

# 检查本地配置、远程连接和 tools/list
npx -y @bigbrain-work/mcp-connect status

# 显示服务实时返回的工具
npx -y @bigbrain-work/mcp-connect tools

# 诊断本机 stdio 启动条件，并实际完成一次 MCP 握手和 tools/list
npx -y @bigbrain-work/mcp-connect doctor

# 只检查运行时和候选配置，不启动 MCP
npx -y @bigbrain-work/mcp-connect doctor --dry-run --json

# 使用实时工具目录校验参数后调用工具
shiliu call <工具名> --args-file <参数.json>

# 大响应可选写入文件；默认不覆盖，显式 --force 才允许覆盖
shiliu call <工具名> --args-file <参数.json> --out <结果.json>

# 每个项目最多每24小时从石榴官网定向刷新一次石榴 Skill
shiliu skill refresh

# 首次安装时记录准确的客户端和范围，后续 refresh 复用该目标
shiliu skill install --agent codex --scope project
shiliu skill install --agent claude-code --scope user

# 其他客户端自行确定 Skill 父目录；CLI 从官网校验、安装并记录真实路径
shiliu skill install --target-dir <CLIENT_SKILL_PARENT> --scope user

# 人工忽略冷却并立即重试
shiliu skill refresh --force

# 撤销刷新令牌并清除本机凭据
npx -y @bigbrain-work/mcp-connect logout
```

安装后也可使用 `shiliu` 命令。原有 `mcp-connect` 命令保持兼容。

旧版 Skill 若没有登记安装目标，即使加 `refresh --force` 也不会被自动接管。 运行 `shiliu doctor --dry-run --json`，查看 `skill.installations` 中的实际路径、范围、登记状态和 `registration` 命令。 doctor 只读检查已知位置及历史记录，不安装、不登记、不移动文件。确认要继续使用某个副本后，在报告的 `cwd` 中显式执行对应 `skill install` 命令；可先加 `--dry-run` 查看是否已有安装及将登记的路径。 显式安装只更新和登记所选路径，保留其他副本。登记后，后续刷新才会按 24 小时冷却机制更新这个目标。

`--url` 和 `--auth-url` 默认只接受石榴 AI 正式服务地址。开发者如需连接 `127.0.0.1`、`localhost` 或 `::1` 上的测试服务，必须显式添加 `--allow-localhost`；该开关不会放行局域网或公网第三方地址。

## 通用 Agent

```bash
npx -y @bigbrain-work/mcp-connect install --agent openclaw
```

对未内置适配器的 Agent，CLI 会输出标准 stdio MCP 配置和本机诊断结果。名称只用于提示，不要求我们枚举所有 Agent。标准 `npx` 配置始终是首选；当当前或持久 PATH 不可靠时，CLI 才额外提供绝对路径备选，并明确提示版本固定和应用升级后路径失效等代价，不会静默替换配置。

Windows 上请使用 CLI 生成的 `cmd /d /s /c npx ... mcp` 配置，不要把 npm 自动生成的 `shiliu.ps1 mcp` 注册为 MCP command；PowerShell 包装器不适合作为长期双向 stdio 通道。MCP 进程遇到登录令牌过期或用户重新扫码后返回的 401，会自动重读系统凭据并重连一次，无需把令牌写入 Agent 配置。

### 先连接，再登录

本地 MCP 桥接进程现在先完成 `initialize`，不在握手前读取凭据或等待远程网络。未登录时，`tools/list` 返回 `shiliu_login`、`shiliu_login_poll`、`shiliu_connection_status` 三个基础工具，Agent 可以先建立连接，再展示微信二维码并按返回间隔短轮询。扫码后仍须轮询领取并保存凭据；手机显示扫码成功不等于电脑端登录完成。

登录成功后，桥接读取本机系统凭据并连接远程服务，加入服务端实时返回的业务工具，发送 `notifications/tools/list_changed`。也兼容在外部终端执行 `shiliu login`，运行中的桥接每 5 秒检查登录变化。客户端若不响应工具列表变更通知，需要刷新工具或重新连接。

未登录、凭据不可读或远程暂时不可达时，基础工具与 MCP 连接保持可用；业务调用返回明确的登录或连接提示。`doctor` 区分本地 MCP 握手成功与远程业务连接成功，三个基础工具不计入业务工具数量。`shiliu status` 和 `shiliu tools` 继续验证已登录的远程服务。

此流程适用于 CLI 提供的本地 stdio 桥接。直接 HTTP MCP 地址仍要求登录凭据，服务端业务接口的鉴权和计费规则保持不变。

### 错误分类与诊断日志

MCP 无法继续运行时，进程退出码区分为：`2` 配置/参数错误（`CONFIG_INVALID`）、`3` Node 版本或依赖不可用（`RUNTIME_UNAVAILABLE`）、`4` 未处理的内部异常（`INTERNAL_ERROR`）；正常关闭为 `0`。两个 CLI 入口均可捕获依赖加载失败，启动后未处理的异常也会输出诊断。

未登录、凭据失效、凭据库不可读和远程暂时不可达分别返回 `LOGIN_REQUIRED`、`AUTH_EXPIRED`、`CREDENTIAL_UNAVAILABLE`、`REMOTE_UNAVAILABLE`，保持 MCP 连接。工具结果含 `code`、`stage`、`message`、`action`；`shiliu_connection_status` 额外返回诊断路径和 `diagnostic_log_available`。诊断只在状态/错误分类变化时记录，避免轮询重复刷日志。

诊断输出为 stderr 上的一行 JSON，并保存在当前系统用户的 `~/.shiliu-ai/logs/mcp-diagnostics.jsonl`。日志到 512 KiB 时轮换，保留一份 `.1` 备份。错误记录包含固定的安全说明、时间、阶段、进程 ID、诊断路径及实际 Node/安装位置。运行环境错误还会给出固定分类与白名单中的缺失模块名，不包含原始异常、堆栈、命令参数、环境变量、请求内容、URL 或凭据。日志写入失败不影响 MCP 连接；请以 `diagnostic_log_available` 判断文件是否成功写入。

`doctor` 失败结果增加 `error_code`、`error_stage`、`process_exit_code`，优先使用连接程序的结构化诊断，避免仅显示 `Connection closed`；未能捕获子进程退出信息时 `process_exit_code` 为 `null`。第三方原始 stderr 不会直接写入报告。客户端仍可能只展示通用断开提示；Agent 可读取上述本地诊断日志继续排查。若 Node 根本无法启动，或进程被系统强制终止，连接程序无法保证产生日志。

`doctor` 只能验证当前机器上的运行时和 stdio 启动链路，不能证明某个 Agent 已经保存、重载或连接 MCP。安装验收应由当前 Agent 通过其原生 MCP 连接调用一次免费的 `get_account_balance`；通过 `shiliu call` 调用只能验证 CLI。`call --dry-run` 只读取实时工具目录并校验参数结构，不执行服务端业务调用。`call --out` 成功时会返回绝对路径、字节数和 SHA-256；写入失败不会留下半成品文件。

## 安装诊断与凭据安全

### 安装验收和定点修复（1.3.11）

安装器先用 `doctor --standard-only --prepare` 预热标准 npx 包，再完成 `initialize` 和 `tools/list` 才报告成功；未登录时三个基础工具也能通过验收。下载/解包不占用握手计时，备选正常安装不会掩盖标准 npx 失败。`--version`、`doctor`、`repair` 的入口只使用 Node 内置模块，SDK/Ajv 缺文件时仍可诊断。Node 不满足最低版本或 CLI 自身诊断文件缺失时，仍需先恢复可运行的 CLI。

终端的全局 CLI 与 Agent 内置 Node 使用的 npx 缓存可能不同。不要把终端验收等同于客户端验收。对于客户端已公开、可读的 JSON 配置，可用下面的模板重现启动；替换路径占位符，保留真实配置的无凭据 command/args：

```text
shiliu doctor --launch-file "CLIENT_MCP_JSON" --node-path "CLIENT_NODE" --npm-cache "CLIENT_NPM_CACHE" --prepare --json
```

没有配置文件时，可用 `--node-path`、`--npm-cli` 和 `--npm-cache` 按实际运行时预热同名包并验证握手。指定启动方式只验证该方式，不用另一份正常安装掩盖失败。报告中的 `validation_scope` 标识验证范围，`stdio_launch.child_runtime`（存在时）来自实际子进程；`runtime.current.process_node` 仍是运行 doctor 的进程。GUI 保存、信任和重连后的原生工具发现仍要单独确认。

保持退出码 3 / `RUNTIME_UNAVAILABLE`，在 `runtime.reason` 中区分 `DEPENDENCY_INCOMPLETE`、`NODE_VERSION_UNSUPPORTED`、`NATIVE_DEPENDENCY_UNAVAILABLE` 等原因；只报告白名单内的 `original_error_code` 和 `missing_module`，不输出原始异常文本。

确认损坏的缓存后，先停用目标客户端石榴 MCP 的自动启动，再分别运行（路径均为占位符）：

```text
shiliu repair --cache-entry "CACHE/_npx/HEX" --node-path "CLIENT_NODE" --npm-cli "CLIENT_NPM_CLI_JS" --npm-cache "CACHE" --dry-run --json
shiliu repair --cache-entry "CACHE/_npx/HEX" --node-path "CLIENT_NODE" --npm-cli "CLIENT_NPM_CLI_JS" --npm-cache "CACHE" --launch-file "CLIENT_MCP_JSON" --json
```

修复命令核对缓存父目录及包归属，拒绝链接目录、共用包缓存、活动连接和并发修复。只把所选石榴 `_npx/HEX` 目录移动到同一缓存下的 `.shiliu-mcp-backups`，重装一次，再验证新缓存本身及选定启动命令。不会清空 npm 缓存、删除其他包或操作登录凭据。新 CLI 的 MCP 启动会尊重修复锁；旧版本不保证配合，仍须先停用客户端自动启动。被中断的锁需确认所有者已结束后人工处理；不自动抢占或反复重装。失败保留备份并报告失败，成功返回 `reload_required`，还需到客户端重连。确认恢复前保留备份。

### 凭据规则

-   不支持 `--api-key` 参数，避免密钥进入 shell 历史。
-   默认微信扫码后获得短期访问令牌；过期前使用可轮换刷新令牌自动更新。
-   令牌保存在 Windows Credential Manager、macOS Keychain 或 Linux Secret Service，不写入 Agent 的 MCP 配置。
-   登录后先以新访问令牌调用一次 `tools/list`，验证成功后才保存。
-   非阻塞登录只把设备码暂存在系统凭据库，JSON 输出不包含设备码或访问令牌。
-   `status --json` 与 `tools --json` 不输出任何令牌。

迁移期如确需使用现有 API Key，可显式运行 `login --legacy-api-key`；此入口将在设备登录稳定后移除。

## 常见问题

### @bigbrain-work/mcp-connect 是什么？

石榴 AI 官方 CLI：登录、配置 Agent、检查 MCP 状态并桥接远程工具。

### 如何安装 @bigbrain-work/mcp-connect？

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

### @bigbrain-work/mcp-connect 支持 TypeScript 吗？

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

### @bigbrain-work/mcp-connect 支持 ESM 还是 CommonJS？

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

### @bigbrain-work/mcp-connect 需要什么版本的 Node\.js？

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

### @bigbrain-work/mcp-connect 可以商用吗？

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

### @bigbrain-work/mcp-connect 的下载量有多少？

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

### @bigbrain-work/mcp-connect 还在维护吗？

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

