Agents Platform

Update Mcp Server Configuration

Update the configuration settings for an MCP server.

patch/v1/convai/mcp-servers/{mcp_server_id}

Path parameters

mcp_server_idstring required

ID of the MCP Server.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

approval_policy'auto_approve_all' | 'require_approval_all' | 'require_approval_per_tool'

Defines the MCP server-level approval policy for tool execution.

force_pre_tool_speechboolean nullable

DEPRECATED: use pre_tool_speech instead. If set, overrides the server's force_pre_tool_speech setting for this tool.

pre_tool_speech'auto' | 'force' | 'off'

disable_interruptionsboolean nullable

DEPRECATED: use interruption_mode instead. If set, overrides the server's disable_interruptions setting for this tool.

interruption_mode'allow' | 'disable_during_tool' | 'disable_during_tool_and_turn'

tool_call_sound'typing' | 'elevator1' | 'elevator2' | 'elevator3' | 'elevator4'

Predefined tool call sounds; None means no sound.

tool_call_sound_behavior'auto' | 'always'

Determines how the tool call sound should be played.

execution_mode'immediate' | 'post_tool_speech' | 'async'

response_timeout_secsinteger nullable

The maximum time in seconds to wait for each MCP tool call to complete.

request_headersobject nullable

The headers to include in requests to the MCP server

request_metaobject nullable

Entries sent in the MCP _meta field of tools/call requests. Values may be JSON scalars, or references to a workspace secret, dynamic variable, or environment variable resolved per call.

disable_compressionboolean nullable

Whether to disable HTTP compression for this MCP server

Response

Successful Response

idstring required

Changes

Changed in 4 of the 30 revisions of this API.23

Aug 19, 2026f053c821dc181See the full diff
- ▲
  response property config/tool_config_overrides/items/input_overrides/anyOf[subschema #1]/additionalProperties/oneOf[subschema #1: ConstantSchemaOverride]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
Aug 6, 20261cae8adcc9652See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jul 27, 2026d39efac71e541See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Jul 26, 2026494d96419d151See the full diff
- ▲
  response property config/tool_config_overrides/items/input_overrides/anyOf[subschema #1]/additionalProperties/oneOf[subschema #1: ConstantSchemaOverride]/constant_value list-of-types was widened by adding types object to media type application/json of response 200
  response-property-list-of-types-widened
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history