get-endpoints
Get all endpoints for a specific API
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | API name | |
| version | No | API version (required when multiple APIs share the same name but differ by version) |
Get all endpoints for a specific API
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | API name | |
| version | No | API version (required when multiple APIs share the same name but differ by version) |
Changes observed during successful MCP inspections. Dates show when Glama detected each change.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations (readOnlyHint=true, idempotentHint=true, destructiveHint=false) already indicate the tool is safe and idempotent. The description adds no behavioral context beyond 'get all', which is consistent but does not disclose traits like pagination or response structure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no wasted words. It achieves conciseness but could be slightly expanded to include output expectations without losing efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description lacks information about the output (no output schema) and does not explain what 'endpoints' includes (e.g., IDs, methods, paths). The agent cannot predict the response format, which hinders usage. With no output schema, the description should compensate but does not.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% (both parameters have clear descriptions). The tool description adds no additional parameter info, so the agent relies solely on the schema. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Get all endpoints for a specific API' clearly states the action (get) and resource (endpoints for a specific API). It distinguishes from sibling tools like list-apis (which lists APIs) and search (generic), making selection straightforward.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like get-endpoint-info or get-full-api-description. The description does not mention context, prerequisites, or limitations, leaving the agent without decision support.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool targets a distinct aspect of API documentation: listing APIs, retrieving endpoints, endpoint details, full description, security schemes, and search. No functional overlap.
Most tools follow a consistent verb_noun pattern (list-apis, get-endpoints, etc.), but 'search' is a single verb, slightly breaking the pattern. Overall naming is clear and predictable.
With 6 tools, the server is well-scoped for its purpose—comprehensive enough without being overwhelming. The number is appropriate for a documentation explorer.
The set covers listing APIs, endpoint details, full spec, security, and search. Minor gaps like endpoint filtering or version comparison exist, but core workflows are well-covered.