Skip to main content
POST

Path Parameters

string
required
The UUID of the server to add the tool to (e.g. 836995ae-1cff-41ec-823e-a4f07ccca3a0). Numeric IDs are also accepted for backwards compatibility.

Body Parameters

string
required
Machine-readable tool name used by AI clients (e.g., get_weather). Use snake_case.
string
Human-readable description. AI clients use this to decide when to call the tool.
string
The HTTP URL to call when the tool is invoked. Supports {param} path placeholders.
string
default:"GET"
HTTP method. One of: GET, POST, PUT, PATCH, DELETE.
object
JSON Schema object defining accepted input parameters.
object
Maps input parameters to their location in the outbound HTTP request. Each key is a parameter name; the value is an object with:
  • target (string, required): where to place the value — path, query, body, or header.
  • key (string, optional): the key name to use in the request. Defaults to the parameter name.
Example: {"city": {"target": "query", "key": "q"}} sends city as ?q=London.
object
Custom HTTP headers to include in every request to the external API.
integer
default:"0"
Cache response for N seconds. Set to 0 to disable.
integer
default:"30"
Request timeout in seconds.
integer
default:"0"
Number of automatic retries on failure (0–5). Retries on connection errors and HTTP status codes 408, 429, 500, 502, 503, 504.
string
default:"exponential"
Delay strategy between retries. One of: none (retry immediately), linear (1s, 2s, 3s…), exponential (1s, 2s, 4s…).
string
default:"active"
Tool status. One of: active, paused.