roo-mcp

用于 Roo 的 MCP 服务器 —— Roo 是智能短链接 API。它以轻量、结构清晰的 MCP 工具形式，将 Roo 的链接及附加功能操作暴露出来，供 LLM 直接调用。

初次使用？ 请参阅 SETUP.md 获取分步安装指南（适用于 Claude Desktop、Claude Code、Cursor）。

安装

选项 A — Claude Code 插件（一条命令，MCP 和技能一并提供）

claude plugin add https://github.com/roo-bz/roo-mcp.git

然后将你的 API 密钥设置为用户环境变量（仅需一次），以便派生的服务器进程能够继承它：

# Windows PowerShell
[Environment]::SetEnvironmentVariable('ROO_API_KEY', 'your-roo-api-key', 'User')

# macOS / Linux — in ~/.zshrc or ~/.bashrc
export ROO_API_KEY=your-roo-api-key

重启终端和 Claude Code。你将同时获得两项内容：

• 14 个 roo_* 工具（通过 .mcp.json 中声明的 MCP 服务器提供）。

• roo-shortlinks 技能（位于 skills/roo-shortlinks/），它教会 Claude 何时使用哪种附加功能。

选项 B — 手动 MCP 配置（Claude Desktop、Cursor、Continue.dev 及其他 MCP 客户端）

添加到你的 MCP 客户端配置文件：

{
  "mcpServers": {
    "roo": {
      "command": "npx",
      "args": ["-y", "@roo-bz/roo-mcp"],
      "env": { "ROO_API_KEY": "your-roo-api-key" }
    }
  }
}

各客户端对应的确切配置文件路径，请参阅 SETUP.md。从 https://roo.bz 获取 API 密钥 —— 请查看你账户的 API 设置。

Related MCP server: shrtnr MCP Server

本地开发

npm install
cp .env.example .env    # then paste ROO_API_KEY into .env
npm run build
node scripts/smoke.mjs  # spawns the built server, calls tools/list + roo_whoami

密钥解析： 启动时，服务器按以下顺序查找 ROO_API_KEY：

1. process.env.ROO_API_KEY —— 这是 MCP 客户端通常通过其 mcpServers.env 配置注入密钥的方式。

2. 包根目录下的 .env（相对于构建后的脚本为 ../）—— 方便本地开发，尤其是当桌面 MCP 客户端（如 Claude Desktop 等）无法可靠地将用户环境变量透传给派生进程时。

如果两者都不存在，服务器将以清晰的错误信息退出。

工具（已实现 / 计划中）

• roo_whoami —— 验证密钥并提供简洁的账户摘要。

• roo_list_shortlinks、roo_create_shortlink、roo_get_shortlink、roo_update_shortlink —— CRUD（增删改查）。

• roo_make_permanent、roo_update_permanent_settings —— 永久性设置。

• roo_get_qr_code —— 获取二维码（base64 data URI 或写入文件）。

• roo_set_scheduled_redirect、roo_set_click_count_redirect、roo_set_webhook、roo_set_preview_link、roo_set_qr_addon —— 五种附加功能。

设计与规范

• DESIGN.md —— 构建简报（工具目录、架构、错误处理）。

• skills/roo-shortlinks/SKILL.md —— 配套的 Claude 技能（判断层），随插件一并提供。

• SPEC-NOTES.md —— 通过实机探测得出的规范与实际实现之间的差异记录。

• roo-openapi.json —— 提取出的 Swagger 2.0 规范。