Skip to main content

Request configuration

Configure the DocSpace MCP server behavior at the request level using query parameters and custom headers.

note

The request configuration parameters are only available for HTTP-like transports.

Query Options

These options can be configured using query parameters in the request URL and are divided into the MCP and API options.

Query parameters are only available if the MCP server is configured to accept configuration via query parameters.

MCP Options

The following options are used to configure the behavior of the MCP server.

dynamic

Enables meta tools for dynamic tool selection. Complementary to toolsets, enabled_tools, and disabled_tools. Mutually exclusive with X-Mcp-Dynamic.

Typeboolean
Trueyes y true 1
Falseno n false 0
Attributestrimmable, case-insensitive

toolsets

Comma-separated list of toolsets to enable. Available toolsets depend on the global server configuration. Mutually exclusive with X-Mcp-Toolsets.

Typecomma-separated list
Examplefiles,people
Attributestrimmable, case-insensitive

enabled_tools

Comma-separated list of tools to explicitly enable. Available tools depend on the global server configuration. Mutually exclusive with X-Mcp-Enabled-Tools.

Typecomma-separated list
Exampleget_file_info,get_all_people
Attributestrimmable, case-insensitive

disabled_tools

Comma-separated list of tools to explicitly disable. Available tools depend on the global server configuration. Mutually exclusive with X-Mcp-Disabled-Tools.

Typecomma-separated list
Exampleget_file_info,get_all_people
Attributestrimmable, case-insensitive

API Options

The following options are used to configure the behavior for API requests.

base_url

Base URL of the DocSpace instance for API requests. Must use HTTP or HTTPS with no search parameters or hash fragments. Mutually exclusive with X-Mcp-Base-Url.

Typeurl
Examplehttps://your-instance.onlyoffice.com/
Attributestrimmable

Header Options

The following options can be configured using custom HTTP headers.

HTTP headers are only available if the MCP server is configured to accept configuration via HTTP headers.

MCP Options

The following options are used to configure the behavior of the MCP server.

X-Mcp-Dynamic

Enables meta tools for dynamic tool selection. Complementary to X-Mcp-Toolsets, X-Mcp-Enabled-Tools, and X-Mcp-Disabled-Tools. Mutually exclusive with dynamic.

Typeboolean
Trueyes y true 1
Falseno n false 0
Attributestrimmable, case-insensitive

X-Mcp-Toolsets

Comma-separated list of toolsets to enable. Available toolsets depend on the global server configuration. Mutually exclusive with toolsets.

Typecomma-separated list
Examplefiles,people
Attributestrimmable, case-insensitive

X-Mcp-Enabled-Tools

Comma-separated list of tools to explicitly enable. Available tools depend on the global server configuration. Mutually exclusive with enabled_tools.

Typecomma-separated list
Exampleget_file_info,get_all_people
Attributestrimmable, case-insensitive

X-Mcp-Disabled-Tools

Comma-separated list of tools to explicitly disable. Available tools depend on the global server configuration. Mutually exclusive with disabled_tools.

Typecomma-separated list
Exampleget_file_info,get_all_people
Attributestrimmable, case-insensitive

Sample custom tool selection

This sample configuration restricts the available tools to a specific set.

X-Mcp-Toolsets: files
X-Mcp-Enabled-Tools: get_all_people
X-Mcp-Disabled-Tools: delete_file,delete_folder

API Options

The following options are used to configure the behavior for API requests.

X-Mcp-Base-Url

Base URL of the DocSpace instance for API requests. Must use HTTP or HTTPS with no search parameters or hash fragments. Required if any authentication header is set. Mutually exclusive with base_url.

Typeurl
Examplehttps://your-instance.onlyoffice.com/
Attributestrimmable

Authorization

Raw value sent in the Authorization header for API requests. Available only if the server is configured to accept this header. Required if the server has no authentication configured and no other authentication option is set. Mutually exclusive with X-Mcp-Api-Key, X-Mcp-Auth-Token, the X-Mcp-Username/X-Mcp-Password pair, and the OAuth flow.

Typestring
ExampleBearer sk-a499e...
Attributessensitive, trimmable

X-Mcp-Api-Key

API key for accessing the API. Required if the server has no authentication configured and no other authentication option is set. Mutually exclusive with Authorization, X-Mcp-Auth-Token, the X-Mcp-Username/X-Mcp-Password pair, and the OAuth flow.

Typestring
Examplesk-a499e...
Attributessensitive, trimmable

X-Mcp-Auth-Token

Personal Access Token (PAT) for accessing the API. Required if the server has no authentication configured and no other authentication option is set. Mutually exclusive with Authorization, X-Mcp-Api-Key, the X-Mcp-Username/X-Mcp-Password pair, and the OAuth flow.

Typestring
ExampleFe4Hrgl6...
Attributessensitive, trimmable

X-Mcp-Username

Username for basic authentication. Used together with X-Mcp-Password. Required if the server has no authentication configured and no other authentication option is set. Mutually exclusive with Authorization, X-Mcp-Api-Key, X-Mcp-Auth-Token, and the OAuth flow.

Typestring
Examplehenry.milton@onlyoffice.com
Attributessensitive, trimmable

X-Mcp-Password

Password for basic authentication. Used together with X-Mcp-Username. Required if the server has no authentication configured and no other authentication option is set. Mutually exclusive with Authorization, X-Mcp-Api-Key, X-Mcp-Auth-Token, and the OAuth flow.

Typestring
Exampleditgor-p...
Attributessensitive, trimmable

Example

The following examples show how to use request configuration headers to customize server behavior for specific requests.

Authentication with API Key

This sample configuration uses an API key for authentication.

X-Mcp-Base-Url: https://your-instance.onlyoffice.com/
X-Mcp-Api-Key: sk-a499e...