Skip to main content
Glama

Claude Platform Docs

get_api_endpoint

Get detailed information about a specific API endpoint including parameters, request body, and responses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAPI path (e.g., /v1/messages)
methodYesHTTP method

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden. 'Get' plus the list of returned fields (parameters, request body, responses) conveys it is a read operation and hints at the return shape, but it says nothing about error behavior for unknown endpoints, auth requirements, or whether the data is cached/live.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence that states the action and the returned content with no filler. Nothing could be cut without losing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter lookup with full schema coverage and no output schema, the description supplies enough: it names the resource and the returned fields, so an agent knows what to expect. Only the note that the response detail is what substitutes for an output schema is left implicit.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters (path, method) are documented with examples and an enum in the schema. The description adds no meaning beyond that, which is acceptable given the schema does the work.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Get') and resource ('a specific API endpoint') and enumerates what detail is returned (parameters, request body, responses). It implicitly distinguishes itself from doc/navigation/search siblings by being endpoint-specific, though it never names them explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied: look up detail for an endpoint when you know its method and path. There is no explicit when-to-use, when-not-to-use, or routing to get_doc/search_docs for broader queries.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources