describe_endpoint
Describe a single API operation including its parameters, response shape, and error codes.
WHEN TO USE:
Inspecting an endpoint's full contract before calling it.
Discovering which error codes an endpoint can return and how to recover.
RETURNS:
operation: Full discovery record for the endpoint.
parameters: Raw OpenAPI parameter definitions.
request_body: Body schema (when applicable).
responses: Map of status code → description/schema.
linked_error_codes: Error catalog entries the endpoint can emit.
EXAMPLE: Agent: "How do I call the screen audience endpoint?" describe_endpoint({ path: "/v1/data/screens/{screenId}/audience", method: "GET" })
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"path": "<path>",
"method": "<method>"
},
"name": "describe_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | The operation path (OpenAPI template form, e.g. "/v1/data/screens/{screenId}/audience"). | |
| method | Yes | HTTP method (case-insensitive). |