返回 MCP 目录
public公开dns本地运行

docspace-mcp

这是一个为ONLYOFFICE DocSpace设计的MCP服务器,它允许AI工具通过自然语言交互直接管理DocSpace中的房间、文件、权限和协作工作流。

article

README

🚀 ONLYOFFICE DocSpace MCP 服务器

[模型上下文协议](MCP)是一种用于管理大语言模型(LLMs)与外部系统之间上下文的标准化协议。本仓库为 ONLYOFFICE DocSpace 提供了一个 MCP 服务器。

DocSpace MCP 服务器可将 AI 工具直接连接到 ONLYOFFICE DocSpace。这使得 AI 代理、助手和聊天机器人能够通过自然语言交互来管理房间、协作处理文件、处理权限并自动化文档工作流程。

✨ 主要特性

  • 工具精细控制:可访问按逻辑组织成工具集的工具,具备细粒度的启用/禁用功能和元工具。
  • 多传输协议支持:支持标准输入输出(stdio)、服务器发送事件(SSE)和可流式传输的 HTTP 传输协议
  • 多种认证方式:支持 API 密钥、个人访问令牌、基本认证以及带有动态客户端注册的 OAuth 2.0。详见示例
  • 请求级配置:在会话初始化期间,可使用自定义 HTTP 头配置认证和工具选择。
  • 多种分发格式:以Docker 镜像Docker MCP 服务器MCP 捆绑包Node.js 应用程序的形式提供。

💻 使用示例

基础用法

以下是该服务器在不同场景下的使用示例:

场景一:房间管理

Create a new project room and invite Anna with editor rights.

场景二:文件操作

Upload this file to "My documents".

高级用法

可根据不同的配置和需求,灵活运用服务器的各种特性。例如,使用不同的认证方式和传输协议,以及对工具进行精细控制等。

📦 安装指南

连接客户端到 DocSpace MCP 服务器

您可以使用任何 MCP 客户端连接到 DocSpace MCP 服务器。我们已经涵盖了一些流行的客户端,如 Claude Desktop、Cursor、Windsurf 等,您可以点击此处了解相关信息。

远程 DocSpace MCP 服务器

远程 DocSpace MCP 服务器由 ONLYOFFICE 托管,为您在 AI 代理中使用 DocSpace 工具提供了最快的方式。您无需在本地部署或配置任何内容,即可立即连接。

支持现代可流式传输 HTTP 传输的客户端可访问公共实例:https://mcp.onlyoffice.com/mcp;仅支持旧版 SSE 传输的客户端可访问:https://mcp.onlyoffice.com/sse。建议尽可能使用可流式传输的 HTTP 传输。

点击此处查看将客户端连接到远程 DocSpace MCP 服务器的所有选项。

本地 DocSpace MCP 服务器

如果您的 MCP 主机不支持远程 MCP 服务器,您可以运行 本地版本 的 DocSpace MCP 服务器。

大多数实现 MCP 协议的客户端都有一个 JSON 格式的通用配置文件,您可以在其中添加 ONLYOFFICE DocSpace MCP 本地服务器。

注意:以下通用示例适用于 Docker 镜像,因此您的系统必须安装 Docker。

  1. 定位配置文件:找到您客户端的 .json 配置文件。
  2. 添加 DocSpace MCP 服务器条目:将以下代码块插入到您 .json 配置文件的 mcpServers 部分:
{
    "mcpServers": {
        "onlyoffice-docspace": {
            "command": "docker",
            "args": ["run", "--interactive", "--rm", "--env", "DOCSPACE_BASE_URL", "--env", "DOCSPACE_API_KEY", "onlyoffice/docspace-mcp"],
            "env": {
                "DOCSPACE_BASE_URL": "https://your-instance.onlyoffice.com",
                "DOCSPACE_API_KEY": "your-api-key"
            }
        }
    }
}
  1. 设置环境变量
    • DOCSPACE_BASE_URL:您的 DocSpace 实例的 URL(例如:https://portal.onlyoffice.com)。
    • DOCSPACE_API_KEY:您在 DocSpace 设置 -> 开发者工具 -> API 密钥中生成的个人 API 密钥。 所有可用参数请点击此处查看。
  2. 重启客户端:关闭并重新打开您的客户端。在大多数情况下,DocSpace MCP 服务器将自动启动,您可以发出自然语言命令,例如:
    • 创建一个新的项目房间,并邀请 Anna 作为编辑人员。
    • 将此文件上传到“我的文档”。

📚 详细文档

服务器实现了 [MCP 规范] 中描述的工具概念。所有 DocSpace MCP 服务器工具的详细信息请点击此处查看。

完整的文档请参考 docs 目录。

📄 许可证

DocSpace MCP 服务器根据 LICENSE 文件中的 Apache 2.0 许可证进行分发。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端