quip-mcp 是一个遵循模型上下文协议(MCP)的服务器实现,旨在为 AI 助手提供对 Quip 文档的全面访问与管理能力。通过该服务器,AI 助手可以与 Quip.com 以及企业专属 Quip 实例进行交互,实现对文档的创建、读取、编辑和删除等完整生命周期操作。
主要能力
- 完整文档生命周期:支持创建、读取、编辑、删除 Quip 文档。
- 智能搜索:提供全面的文档搜索功能。
- 最近文档:可访问用户最近查看或编辑过的文档。
- 用户管理:获取用户信息与详情。
- 评论管理:检索和管理文档讨论与评论。
- Markdown 支持:全程保持清晰的 Markdown 格式。
- 健壮的 API:能够处理复杂的 Quip API 响应结构。
- 安全性:基于令牌的身份验证,并支持企业实例。
使用方式
快速安装
- 安装二进制文件:从 releases 页面下载适合您平台的二进制文件。
- 添加到 Cursor(一键):安装二进制文件后,点击按钮将 MCP 服务器配置添加到 Cursor IDE。注意:该按钮仅添加 MCP 配置,仍需先完成第一步的二进制安装。
- 获取 API 令牌:访问您的 Quip 实例(如
https://your-company.quip.com/dev/token),生成新的 API 令牌。 - 配置服务器:运行
quip-mcp --setup。 - 添加到 MCP 客户端:参考下方对应客户端的说明。
MCP 客户端配置
- Cursor:点击 README 顶部的“Add to Cursor”按钮,或在 Cursor 设置中手动添加服务器:
{
"mcpServers": {
"quip-mcp": {
"command": "quip-mcp"
}
}
}
- Claude:可通过命令行或配置文件添加。具体命令或配置请参考官方文档。
- 其他 MCP 客户端:通常在设置中添加新服务器,使用上述类似配置。
更新
使用一条命令即可更新至最新版本。更新脚本会:检查当前版本、若已是最新则跳过更新、仅在有新版本时安装、保留现有配置。
可用工具
项目提供了多个工具,支持获取最近文档、搜索文档、读取文档内容、创建新文档、编辑现有文档、删除文档等操作。
配置
服务器会自动将令牌保存至:
- Linux/macOS:
~/.config/quip-mcp/config.yaml - Windows:
%APPDATA%/quip-mcp/config.yaml
可通过环境变量或配置文件进行配置。
公司实例支持
该服务器同时适用于 Quip.com 和公司专属实例(如 https://your-company.quip.com)。API 令牌会自动处理到特定实例的路由。
安全措施
- 令牌存储时具有受限的文件权限(0600)
- 所有 API 通信使用 HTTPS
- 不记录敏感数据
故障排除
- “未找到 API 令牌”:请确保已正确获取并配置令牌。
- “搜索不可用”:部分 Quip 实例禁用了搜索功能,可改为使用直接的文档 ID。可从 Quip URL 中提取文档 ID:
https://company.quip.com/DOCUMENT_ID/title。 - “权限被拒绝”:确保 API 令牌具有适当权限,并检查 Quip 中的文档访问级别。
适用场景
适用于需要将 Quip 文档操作集成到 AI 助手工作流中的用户,例如在 Cursor 或 Claude 等 MCP 客户端中直接搜索、阅读、创建、编辑或删除 Quip 文档,提升文档管理效率。
限制
该工具需要有效的 Quip API 令牌,且部分 Quip 实例可能禁用搜索功能,此时需依赖文档 ID 进行操作。