Skip to main content
Glama

get_endpoint_details

Retrieve detailed schema for an API endpoint, with options for compact field:type summary or full OpenAPI schema and selective sections.

Instructions

Get detailed schema for a specific endpoint. Returns compact field:type summary by default. Use compact=false for raw OpenAPI schema. Use sections to request only specific parts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAPI path
methodYesHTTP method (GET, POST, etc.)
sectionsNoRequest specific sections only: 'summary', 'parameters', 'request_body', 'responses', 'content_types'. Default: all.
compactNoIf true (default), show compact field:type summary. If false, return raw OpenAPI schema including $refs. Use compact=false if compact shows empty body.
Behavior4/5

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

With no annotations, the description carries the burden. It explains default behavior (compact summary) and options, but does not mention error handling or edge cases like missing endpoints. Adequate but not fully comprehensive.

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?

Three sentences, each adding specific value. Front-loaded with purpose, no unnecessary words. Efficiently conveys key 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?

Given no output schema, the description provides a high-level idea of the return format (compact summary vs raw schema). However, it lacks details on the structure of the compact summary or error responses. Still sufficient for most uses.

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

Parameters4/5

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

Schema coverage is 100% so baseline is 3. The description adds value by explaining the compact default and when to use false, and the purpose of sections. This goes beyond the schema, raising the score to 4.

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

Purpose5/5

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

The description clearly states 'Get detailed schema for a specific endpoint.' This verb+resource purpose is specific and distinguishes it from sibling tools like list_endpoints (which lists endpoints) or execute_request (which executes requests).

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

Usage Guidelines4/5

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

Provides clear guidance on when to use compact=false and sections, but does not explicitly contrast with alternatives like list_endpoints or search_schema. Still, the usage context is well implied.

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/fellowabhi/ControlAPI-openapi-to-mcp'

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