rustpad-mcp

一个 Model Context Protocol 服务器，用于 Rustpad —— 一款高效、极简、自托管的协作式文本编辑器。

它让 AI 助手能够读取和写入某个 Rustpad 实例中的便签（pad）。读取操作通过 Rustpad 的 HTTP API 进行；写入操作则使用操作变换（OT）WebSocket 协议，因此定向编辑（append_to_document、replace_in_document）能够与人类协作者同时输入的内容干净地合并，而不是将其覆盖。当服务器编辑某个便签时，它会以名为 rustpad-mcp 的协作者身份出现在该便签中，对所有人可见。

📖 完整文档：rustpad-mcp.ni-c.de

系统要求

• 一个可访问的 Rustpad 实例（自托管；该 MCP 服务器无状态，且不需要任何凭据——Rustpad 没有认证机制）

• Node.js >= 22，或 Docker

Related MCP server: SSH MCP Server

配置

同一个 URL 同时用于 HTTP API、WebSocket 端点和工具返回的分享链接（<RUSTPAD_URL>/#<pad-id>）。布尔值必须严格为 true。服务器无需配置即可启动并列出其工具；此后每次调用都会失败并返回设置指引。

请牢记 Rustpad 的本质：便签是临时的（服务器重启后会丢失，闲置 24 小时后也会丢失，除非实例通过 SQLITE_URI 运行），并且任何知道便签 id 的人都可以读取和写入它。不要将机密信息放进便签中。

安装

Claude Code

claude mcp add rustpad --env RUSTPAD_URL=https://rustpad.example.net -- npx rustpad-mcp

Claude Desktop

{
  "mcpServers": {
    "rustpad": {
      "command": "npx",
      "args": ["rustpad-mcp"],
      "env": {
        "RUSTPAD_URL": "https://rustpad.example.net"
      }
    }
  }
}

Codex

~/.codex/config.toml:

[mcp_servers.rustpad]
command = "npx"
args = ["-y", "rustpad-mcp"]

[mcp_servers.rustpad.env]
RUSTPAD_URL = "https://rustpad.example.net"

Docker

docker run -i --rm -e RUSTPAD_URL=https://rustpad.example.net ghcr.io/ni-c/rustpad-mcp

工具

当 RUSTPAD_READ_ONLY=true 时，只会注册前三个工具。

安全

• 便签内容对所有人可写，因此不可信：每个读取结果都会带有前缀标记，告知模型将其视为数据，绝不视为指令。

• 替换非空便签是不可逆的，受一次性确认令牌保护；该令牌只会出现在之前的工具结果中。

• 工具结果有大小上限；上游错误响应在到达模型之前会被净化处理。

• RUSTPAD_INSECURE_TLS 仅对配置的连接放宽证书校验，绝不会影响整个进程。

开发

npm install
npm run lint && npm run build && npm test

测试套件通过真实的 MCP 协议与 rustpad-server 的内存版模拟实现（包括对并发编辑的 OT 变换）进行交互，无需真实实例。架构图和社会卡片（social card）都是生成的——请编辑 docs/assets/architecture.source.svg 并运行 npm run assets，切勿直接修改渲染后的副本。

发布

发布由标签（tag）驱动。更新 package.json 的版本号，将 CHANGELOG.md 中 [Unreleased] 的记录移到新版本下，提交，然后：

git tag -s vX.Y.Z -m "vX.Y.Z"
git push origin main vX.Y.Z

发布工作流通过 Trusted Publishing（OIDC，带 provenance）发布到 npm，将多架构容器镜像推送到 GHCR，根据 CHANGELOG 中的对应部分创建 GitHub release，并更新官方 MCP 注册表中的条目。

许可证

MIT © Willi Thiel