Skip to main content
Glama

inspect

Read-onlyIdempotent

Retrieve the full OpenAPI operation object for any endpoint — parameters, request body, response schemas, and definitions. Use to understand exact technical details before calling an endpoint via invoke.

Instructions

inspect

Retrieves the full OpenAPI operation object for an endpoint — parameters, request body, response schemas, and all definitions.

Use this when you need complete technical details before invoking an endpoint or explaining its contract to the user.

For a quick summary (method, path, summary only), use endpoint_by_id instead.

When to use

Use this tool when:

  • The user asks "show me the full spec for this endpoint"

  • You need to understand the exact schema for request/response bodies

  • You need to know which parameters (path, query, header) an endpoint accepts

  • You are preparing to call an endpoint via invoke and need to build the correct request

  • The user asks for examples, response codes, or technical contract details

Parameters

  • endpointId (required): The 32-character MD5 hash ID of the endpoint to inspect

Returns

The full OpenAPI operation object including parameters (with schemas), request body, responses, and all referenced schema definitions.

Note on auth-injected parameters

Some required parameters shown by inspect may be auth credentials (e.g. api_key, timestamp, signature, recvWindow). These are injected automatically by swag2mcp during invoke — do NOT pass them in parameters. Only pass genuine business parameters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endpointIdYesrequired,The 32-character MD5 hash ID of the endpoint to inspect
Behavior5/5

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

Annotations already mark this as read-only and idempotent, and the description adds valuable context: the note about auth-injected parameters being automatically handled and not to be passed. This explains critical behavior beyond the annotations.

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?

Well-structured with clear headings, bullet lists, and a concise note. Each section adds essential information without redundancy or unnecessary filler.

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?

Despite lacking an output schema, the description fully explains the return value (full OpenAPI operation object) and includes the critical auth-injection warning. For a simple single-parameter tool with good annotations, this is complete.

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 already covers the single parameter with 100% coverage, but the description reinforces that `endpointId` is a 32-character MD5 hash and adds usage nuance about auth parameters. The baseline is 3; the extra clarification warrants a 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 the tool's purpose: 'Retrieves the full OpenAPI operation object for an endpoint' — a specific verb and resource. It distinguishes from sibling tool `endpoint_by_id` by noting the difference between full spec and quick summary.

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?

Explicit 'When to use' section lists concrete scenarios, and directly names the alternative `endpoint_by_id` for quick summaries. This gives clear guidance on choosing this tool over others.

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/mmadfox/swag2mcp'

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