Skip to main content
Glama
anuoua

swagger-doc-explorer-mcp

by anuoua

Get Endpoint Details (All $ref Resolved)

swagger_get_endpoint_full
Read-onlyIdempotent

Retrieve a complete API endpoint definition with all schema references expanded inline. Avoid manual $ref resolution and get fully resolved parameters, request, and response schemas in one call.

Instructions

Get detailed information about a specific API endpoint with all schema references ($ref) recursively resolved.

Unlike swagger_get_endpoint, this tool resolves every $ref into its full schema definition. Parameters, request body schemas, and response schemas are expanded inline with no external references. Circular references are detected and marked.

Use this when you need the complete endpoint definition in a single call, without needing to follow $ref links manually.

Args:

  • spec_name (string): Name of the previously loaded spec

  • path (string): URL path of the endpoint (e.g., "/pets/{petId}")

  • method (string): HTTP method (get, post, put, patch, delete, options, head)

Returns: Full endpoint details with all $ref resolved recursively.

Examples:

  • Use when: "Show me everything about GET /pets/{petId} with all schemas expanded" -> params with spec_name="", path="/pets/{petId}", method="get"

  • Use when: "Give me the full request body schema for creating a user" -> params with spec_name="", path="/users", method="post"

Error Handling:

  • Returns error if the spec name has not been loaded

  • Returns error if the path or method is not found, with suggestions

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesURL path of the endpoint (e.g., '/pets/{petId}', '/users', '/store/order'). Must start with '/'.
methodYesHTTP method (get, post, put, patch, delete, options, head)
spec_nameYesName of the previously loaded OpenAPI/Swagger spec (use swagger_list_loaded to see available names)
Behavior5/5

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

The description discloses behavioral details beyond annotations: it resolves all $refs recursively, detects and marks circular references, and returns errors for missing specs or invalid paths/methods with suggestions. Annotations already declare read-only/idempotent safety, and the description adds functional transparency.

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 well-structured with a clear opening statement, followed by contrast, usage guidance, args recap, return description, and error handling. Despite being lengthy, every section adds information—no fluff. It is front-loaded with the core purpose.

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

Completeness5/5

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

For a read-only query tool without an output schema, the description adequately covers expected return, error scenarios, and circular reference behavior. It also provides examples and usage context, making it self-contained for an agent.

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?

The input schema already provides 100% coverage with descriptions for all three parameters; the description restates them but adds value through examples that map natural language requests to concrete parameter values. The schema itself includes enums and example paths, so the incremental contribution is moderate but useful.

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 the tool provides detailed endpoint information with all $ref resolved recursively, using a specific verb ('Get') and resource ('endpoint details'). It explicitly distinguishes itself from swagger_get_endpoint by highlighting the $ref resolution behavior, making the purpose unambiguous.

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

Usage Guidelines5/5

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

The description says 'Use this when you need the complete endpoint definition in a single call, without needing to follow $ref links manually' and provides concrete examples of when to use it. It contrasts with swagger_get_endpoint, effectively guiding selection between alternatives.

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/anuoua/swagger-doc-explorer-mcp'

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