Skip to main content
Glama
Swagger MCP Server

Swagger MCP Server

by tsiva18

get_api_details

Retrieves complete documentation for a specified API endpoint, including parameters, request body, and responses.

Instructions

Get complete endpoint documentation including parameters, request body and responses.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>",
      "method": "<method>"
    },
    "name": "get_api_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesAPI endpoint path (e.g. /users/{id})
methodYesHTTP method (e.g. GET, POST, PUT, DELETE)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a read-only lookup and names the returned sections, but says nothing about authentication needs, behavior when path/method don't match a documented endpoint, or how missing sections (e.g. no request body for GET) are represented.

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?

A single front-loaded sentence that states the action and the content of the result with zero filler. Nothing is redundant or misplaced.

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

Completeness3/5

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

For a simple two-parameter lookup with full schema coverage and no output schema, the description is adequate but thin: it covers what comes back yet omits lookup-failure behavior and how it differs from get_api_schema. That leaves a real selection gap for the agent.

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 both path and method documented including examples, so the schema already does the heavy lifting. The description's mention of "parameters" refers to returned documentation, not the input arguments, so it adds no meaning beyond the schema.

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 gives a clear verb+resource ("Get complete endpoint documentation") and enumerates what the documentation contains (parameters, request body, responses), so the agent knows what it retrieves. It does not distinguish itself from the sibling get_api_schema, leaving ambiguity about which tool to pick for schema-style information.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no exclusions, and no mention of the sibling tools such as get_api_schema or search_api. The agent must infer that this is the lookup for full docs versus schema-only or search flows.

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