io.github.ONLYOFFICE/docspace

Official

by ONLYOFFICE · TypeScript

A room-based collaborative platform

Room-based collaborative platform for document and team management.

Topics

docspacemcponlyofficemcp-server

README.md6 KBView on GitHub

ONLYOFFICE DocSpace MCP Server

Model Context Protocol (MCP) is a standardized protocol for managing context between large language models (LLMs) and external systems. This repository provides an MCP server for ONLYOFFICE DocSpace.

The DocSpace MCP Server connects AI tools directly to ONLYOFFICE DocSpace. This gives AI agents, assistants, and chatbots the ability to manage rooms, collaborate on files, handle permissions, and automate document workflows - all through natural language interactions.

Features

Tools with granular control - Access to tools organized into logical toolsets with fine-grained enable/disable capabilities and meta tools.
Multiple transport protocols - Support for stdio, SSE, and Streamable HTTP transports.
Different authentication methods - Supports API keys, Personal Access Tokens, Basic authentication, and OAuth 2.0 with dynamic client registration. See examples.
Request-level configuration - Configure authentication and tool selection during session initialization using custom HTTP headers.
Various distribution formats - Available as Docker image, Docker MCP Server, MCP bundle, and Node.js application.

Use Cases

Room Management: Create, update, and archive rooms. Configure room types, manage membership, and control access levels.
Folder & File Operations: Create folders, upload documents, copy or move items in batches, rename or delete content, and check file or folder details.
Collaboration & Permissions: Invite or remove users, adjust security settings, and review current access rights for rooms and shared spaces.
Content Access: Retrieve "My documents" or "Rooms" folders, get folder contents, download files as text, and monitor ongoing file operations.
People Directory: List all people in the portal to streamline invitations and access management.

Connecting Clients to DocSpace MCP Server

You can connect to the DocSpace MCP server using any MCP clients. We have covered some popular clients, such as Claude Desktop, Cursor, Windsurf, etc., and here you can read about it.

Remote DocSpace MCP Server

The remote DocSpace MCP Server is hosted by ONLYOFFICE and provides the fastest way to start using DocSpace tools inside your AI agent. You can connect to it instantly without deploying or configuring anything on your machine.

The public instance is available at https://mcp.onlyoffice.com/mcp for clients that support modern Streamable HTTP transport and at https://mcp.onlyoffice.com/sse for clients that support only the legacy SSE transport. It is preferable to use the Streamable HTTP transport whenever possible.

See all options for connecting clients to the Remote DocSpace MCP Server here.

Local DocSpace MCP Server

If your MCP host does not support remote MCP servers, you can run the local version of the DocSpace MCP Server instead.

Most clients that implement the MCP protocol have a common configuration file in the JSON format, inside which you can add the ONLYOFFICE DocSpace MCP Local Server.

Note: The common example below is applicable for Docker image, so Docker must be installed on your system.

Step 1. Locate your config file

Find your client .json configuration file.

Step 2. Add the DocSpace MCP Server entry

Insert the following block into the mcpServers section of your .json configuration file:

json

{
	"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"
			}
		}
	}
}

Step 3. Set environment values

DOCSPACE_BASE_URL - the URL of your DocSpace instance (e.g. https://portal.onlyoffice.com).
DOCSPACE_API_KEY - your personal API key generated in DocSpace settings -> Developer Tools -> API keys.

All available parameters are listed here.

Step 4. Restart the client

Close and reopen your client. In most cases, the DocSpace MCP Server will start automatically, and you'll be able to issue natural language commands like:

Create a new project room and invite Anna with editor rights.
Upload this file to "My documents".

Tools

The DocSpace MCP server implements the Tools concept described in the MCP specification.

All DocSpace MCP server tools are described here.

Documentation

The documentation is available in the docs directory.

Samples

The following examples show how to use ONLYOFFICE DocSpace MCP server.

Privacy Policy

The policies are available at Legal Terms and Privacy Policy.

License

The DocSpace MCP server is distributed under the MIT license found in the LICENSE file.

Install

Configuration

Environment variables

DOCSPACE_BASE_URL

The base URL of the DocSpace instance for API requests.

DOCSPACE_API_KEYsecret

The API key for accessing the API.

DOCSPACE_TRANSPORTdefault stdio

The transport protocol to use for communication with the MCP server.

DOCSPACE_DYNAMICdefault false

The flag that indicates whether the MCP server should use meta tools.

DOCSPACE_TOOLSETSdefault all

The list of toolsets to enable for the MCP server.

DOCSPACE_ENABLED_TOOLS

The list of tools to enable for the MCP server.

DOCSPACE_DISABLED_TOOLS

The list of tools to disable for the MCP server.

DOCSPACE_USER_AGENTdefault @onlyoffice/docspace-mcp v3.2.0

The user agent to include in the User-Agent header for API requests.

DOCSPACE_AUTHORIZATIONsecret

The raw value to include in the Authorization header for API requests.

DOCSPACE_AUTH_TOKENsecret

The Personal Access Token (PAT) for accessing the API.

DOCSPACE_USERNAME

The username for accessing the API using basic authentication.

DOCSPACE_PASSWORDsecret

The password for accessing the API using basic authentication.

DOCSPACE_SESSION_TTLdefault 28800000

The time-to-live (TTL) for HTTP sessions in milliseconds.

DOCSPACE_SESSION_INTERVALdefault 240000

The interval for checking HTTP sessions for expiration in milliseconds.

DOCSPACE_OAUTH_BASE_URL

The base URL of the DocSpace OAuth service for OAuth requests.

DOCSPACE_OAUTH_CLIENT_ID

The client ID of the OAuth application.

DOCSPACE_OAUTH_CLIENT_SECRETsecret

The client secret of the OAuth application.

DOCSPACE_OAUTH_AUTH_TOKEN_ALGORITHMdefault HS256

The algorithm to use for signing OAuth access tokens.

DOCSPACE_OAUTH_AUTH_TOKEN_TTLdefault 3600000

The time-to-live (TTL) for OAuth access tokens in milliseconds.

DOCSPACE_OAUTH_AUTH_TOKEN_SECRET_KEYsecret

The secret key to use for signing OAuth access tokens.

DOCSPACE_OAUTH_STATE_TOKEN_ALGORITHMdefault HS256

The algorithm to use for signing OAuth state tokens.

DOCSPACE_OAUTH_STATE_TOKEN_TTLdefault 3600000

The time-to-live (TTL) for OAuth state tokens in milliseconds.

DOCSPACE_OAUTH_STATE_TOKEN_SECRET_KEYsecret

The secret key to use for signing OAuth state tokens.

DOCSPACE_SERVER_BASE_URL

The base URL of the server.

DOCSPACE_HOSTdefault 127.0.0.1

The host to bind the server to.

DOCSPACE_PORTdefault 8080

The port to bind the server to.

DOCSPACE_SERVER_PROXY_HOPSdefault 0

The number of proxy servers between the server and the client.

DOCSPACE_SERVER_CORS_MCP_ORIGINdefault *

The list of allowed origins to include in the Access-Control-Allow-Origin header for CORS requests to MCP endpoints.

DOCSPACE_SERVER_CORS_MCP_MAX_AGEdefault 86400000

The maximum age in milliseconds to include in the Access-Control-Max-Age header for CORS requests to MCP endpoints.

DOCSPACE_SERVER_CORS_OAUTH_ORIGINdefault *

The list of allowed origins to include in the Access-Control-Allow-Origin header for CORS requests to OAuth endpoints.

DOCSPACE_SERVER_CORS_OAUTH_MAX_AGEdefault 86400000

The maximum age in milliseconds to include in the Access-Control-Max-Age header for CORS requests to OAuth endpoints.

DOCSPACE_SERVER_RATE_LIMITS_MCP_CAPACITYdefault 1000

The maximum number of requests allowed per window for the MCP endpoints.

DOCSPACE_SERVER_RATE_LIMITS_MCP_WINDOWdefault 1000

The time window in milliseconds for the rate limit for the MCP endpoints.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_SERVER_METADATA_CAPACITYdefault 200

The maximum number of requests allowed per window for the OAuth server metadata endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_SERVER_METADATA_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth server metadata endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_RESOURCE_METADATA_CAPACITYdefault 200

The maximum number of requests allowed per window for the OAuth resource metadata endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_RESOURCE_METADATA_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth resource metadata endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_AUTHORIZE_CAPACITYdefault 200

The maximum number of requests allowed per window for the OAuth authorization endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_AUTHORIZE_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth authorization endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_CALLBACK_CAPACITYdefault 200

The maximum number of requests allowed per window for the OAuth callback endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_CALLBACK_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth callback endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_INTROSPECT_CAPACITYdefault 10

The maximum number of requests allowed per window for the OAuth introspection endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_INTROSPECT_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth introspection endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_REGISTER_CAPACITYdefault 10

The maximum number of requests allowed per window for the OAuth client registration endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_REGISTER_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth client registration endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_REVOKE_CAPACITYdefault 10

The maximum number of requests allowed per window for the OAuth token revocation endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_REVOKE_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth token revocation endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_TOKEN_CAPACITYdefault 10

The maximum number of requests allowed per window for the OAuth token endpoint.

DOCSPACE_SERVER_RATE_LIMITS_OAUTH_TOKEN_WINDOWdefault 60000

The time window in milliseconds for the rate limit for the OAuth token endpoint.

DOCSPACE_REQUEST_QUERYdefault true

The flag that indicates whether the server should accept configuration via query parameters in incoming requests.

DOCSPACE_REQUEST_AUTHORIZATION_HEADERdefault true

The flag that indicates whether the server should check for the Authorization header in incoming requests.

DOCSPACE_REQUEST_HEADER_PREFIXdefault x-mcp-

The prefix to use with custom configuration headers.

claude_desktop_config.json

{
  "mcpServers": {
    "docspace": {
      "command": "npx",
      "args": [
        "-y",
        "@onlyoffice/docspace-mcp@3.2.0"
      ],
      "env": {
        "DOCSPACE_TRANSPORT": "stdio",
        "DOCSPACE_DYNAMIC": "false",
        "DOCSPACE_TOOLSETS": "all",
        "DOCSPACE_ENABLED_TOOLS": "<YOUR_DOCSPACE_ENABLED_TOOLS>",
        "DOCSPACE_DISABLED_TOOLS": "<YOUR_DOCSPACE_DISABLED_TOOLS>",
        "DOCSPACE_USER_AGENT": "@onlyoffice/docspace-mcp v3.2.0",
        "DOCSPACE_BASE_URL": "<YOUR_DOCSPACE_BASE_URL>",
        "DOCSPACE_AUTHORIZATION": "<YOUR_DOCSPACE_AUTHORIZATION>",
        "DOCSPACE_API_KEY": "<YOUR_DOCSPACE_API_KEY>",
        "DOCSPACE_AUTH_TOKEN": "<YOUR_DOCSPACE_AUTH_TOKEN>",
        "DOCSPACE_USERNAME": "<YOUR_DOCSPACE_USERNAME>",
        "DOCSPACE_PASSWORD": "<YOUR_DOCSPACE_PASSWORD>"
      }
    }
  }
}