Create Mcp Tool Configuration Override

Create configuration overrides for a specific MCP tool.

mcp_server_idstring required

ID of the MCP Server.

environmentstring

Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.

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

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_behavior'auto' | 'always'

Determines how the tool call sound should be played.

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

response_timeout_secsinteger nullable

If set, overrides the server's response timeout for this MCP tool.

input_overridesobject nullable

Mapping of json path to input override configuration

tool_namestring required

The name of the MCP tool

Example request

{
  "assignments": [
    {
      "dynamic_variable": "user_name",
      "preserve_native_type": false,
      "sanitize": false,
      "source": "response",
      "value_path": "user.name"
    }
  ]
}

Response

Successful Response

idstring required

v4

Create Mcp Tool Configuration Override

Path parameters

Query parameters

Headers

Request body

Example request

Response