Skip to main content
Version: 2.0

Update Tool API Definition

The Update Tool API enables you to modify the configuration of existing tools discovered from MCP servers. Currently, this API supports enabling or disabling tools, allowing administrators to control tool availability for agent configurations without requiring changes to the underlying MCP server.

This API is essential for managing tool lifecycle, implementing phased rollouts of new capabilities, temporarily disabling problematic tools, and controlling which tools are available in different environments or for different user segments.

Update Tool Request and Response

To update a tool, send a PATCH request to /v2/tools/{tool_id}. You specify the following parameters:

  • tool_id (string, required): Tool identifier in the URL path following pattern tol_[0-9a-zA-Z_-]+$
  • Request body parameters:
    • type (string, required): Must be mcp (only MCP tools can be updated)
    • enabled (boolean, required): Whether the tool should be enabled or disabled

The response includes the complete updated tool configuration with all metadata.

Example Request

EXAMPLE REQUEST
1

Example Response

EXAMPLE RESPONSE
1

Error Responses

The API returns standard HTTP error codes with detailed error information:

HTTP CodeError CodeDescription
400invalid_requestMissing required fields or malformed request structure
400invalid_tool_typeTool type must be 'mcp' for updates
401unauthorizedInvalid or missing API key
403forbiddenInsufficient permissions for updating this tool
404tool_not_foundTool with the specified ID does not exist
429rate_limit_exceededUpdate rate limit exceeded

Notes

  • Only MCP tools can be updated through this API
  • Tool metadata like name, description, and input schema are synchronized from the MCP server and cannot be modified directly
  • To update tool behavior beyond enabling/disabling, use Tool Configurations instead
  • Changes take effect immediately for new agent sessions but do not affect existing active sessions