🚀 ONLYOFFICE DocSpace MCP 服务器
[模型上下文协议] (MCP) 是一个标准化协议，用于在大型语言模型（LLM）和外部系统之间管理上下文。本仓库提供了一个针对 [ONLYOFFICE DocSpace.] 的 MCP 服务器。
🚀 快速开始
本项目提供的 MCP 服务器可用于在大型语言模型和外部系统间管理上下文，为相关操作提供便利。
📦 安装指南
大多数实现 MCP 协议的客户端都有一个常见的 JSON 格式配置文件，在其中可以添加 ONLYOFFICE DocSpace MCP 服务器，如下所示：
{
"mcpServers": {
"onlyoffice-docspace": {
"env": {
"DOCSPACE_BASE_URL": "https://your-instance.onlyoffice.com",
"DOCSPACE_API_KEY": "your-api-key"
},
"command": "npx",
"args": ["--yes", "@onlyoffice/docspace-mcp"]
}
}
}
有关使用 Claude Desktop 安装 MCP 服务器的更详细示例，请参见如何操作。
📚 详细文档
配置
配置 ONLYOFFICE DocSpace MCP 服务器的唯一方式是通过环境变量。下表列出了可用的环境变量及其描述：
| 属性 | 详情 |
|---|---|
DOCSPACE_BASE_URL |
DocSpace 实例的基础 URL。此配置是进行 API 请求所必需的。 |
DOCSPACE_ORIGIN |
DocSpace 实例的来源。此配置不是必须的，但可用于指定请求中的 Origin 标头。 |
DOCSPACE_USER_AGENT |
请求中使用的用户代理。此配置不是必须的，但可用于指定请求中的 User-Agent 标头。 |
DOCSPACE_API_KEY |
访问 DocSpace API 所需的 API 密钥。此配置是必需的，如果既没有提供 DOCSPACE_AUTH_TOKEN 也没有提供 DOCSPACE_USERNAME 和 DOCSPACE_PASSWORD 的情况下。 |
DOCSPACE_AUTH_TOKEN |
访问 DocSpace API 所需的身份验证令牌。此配置是必需的，如果既没有提供 DOCSPACE_API_KEY 也没有提供 DOCSPACE_USERNAME 和 DOCSPACE_PASSWORD 的情况下。 |
DOCSPACE_USERNAME |
使用基本身份验证访问 DocSpace API 的用户名。此配置是必需的，如果既没有提供 DOCSPACE_API_KEY 也没有提供 DOCSPACE_AUTH_TOKEN 的情况下。这与 DOCSPACE_PASSWORD 配合使用。 |
DOCSPACE_PASSWORD |
使用基本身份验证访问 DocSpace API 的密码。此配置是必需的，如果既没有提供 DOCSPACE_API_KEY 也没有提供 DOCSPACE_AUTH_TOKEN 的情况下。这与 DOCSPACE_USERNAME 配合使用。 |
使用
工具列表
下表列出了所有可用工具及其描述：
| 序号 | 名称 | 描述 |
|---|---|---|
| 1 | files.download |
下载文件 |
| 2 | files.upload |
上传文件 |
| 3 | files.delete |
删除文件 |
| 4 | files.list |
列出所有文件 |
| 5 | directories.create |
创建目录 |
| 6 | directories.delete |
删除目录 |
| 7 | directories.list |
列出所有目录 |
| 8 | people.get_all |
获取所有用户 |
📄 许可证
此 SDK 按照 Apache - 2.0 许可证分发，具体内容请参见 LICENSE 文件。