Skip to main content
Glama

get_endpoint_details

Retrieve endpoint details, including parameters and responses, along with a usage example to clarify API usage.

Instructions

Get complete details and usage example for a specific endpoint

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_nameYesAPI name (e.g., "hetzner/cloud", "ory/kratos")
pathYesEndpoint path (e.g., "/users")
methodYesHTTP method
Behavior3/5

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

No annotations are provided, so the description must cover behavioral traits. It merely describes the action without mentioning side effects (e.g., read-only, no modifications). The description is adequate for a simple retrieval tool but lacks transparency about non-destructiveness or prerequisites.

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?

The description is a single sentence with no unnecessary words. It is concise and directly describes the tool's purpose.

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?

Given the tool's simplicity (3 well-described parameters, no output schema, no annotations), the description provides sufficient context for an agent to understand its functionality. However, it could mention that the endpoint must exist, making it slightly more complete.

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 description coverage is 100%, with clear parameter descriptions. The tool description adds no additional meaning beyond the schema, so baseline score of 3 is appropriate.

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 clearly states 'Get complete details and usage example for a specific endpoint'. The verb 'Get' and resource 'complete details and usage example' are specific. However, it does not explicitly distinguish from sibling tools like get_schema_details, which might cause confusion.

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?

No guidance on when to use this tool versus alternatives. The description is generic and does not provide context for choosing it over siblings like search_endpoints or get_schema_details.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/productdevbook/sufetch'

If you have feedback or need assistance with the MCP directory API, please join our Discord server