Skip to main content
Glama
Sign In
swagger-mcp

swagger-mcp

by emreycolakoglu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

API overview

get_api_overview
Read-only

Retrieve top-level API metadata including title, version, description, servers, and security. Use this to get a quick overview of an unfamiliar API specification.

Instructions

Top-level API metadata: title, version, description, servers, global security, and counts. Start here on an unfamiliar API.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_api_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
specNoURL or local path of the OpenAPI/Swagger spec. Defaults to the server's configured API_DOCS_URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations indicate readOnlyHint=true and openWorldHint=false. The description adds context by listing returned fields (title, version, etc.) and counts, which is valuable beyond annotations. No contradictions.

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?

Two sentences: first lists contents, second provides usage recommendation. Every word is purposeful, no redundancy.

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?

Given 1 optional parameter, strong annotations, and no output schema, the description adequately explains the output and usage. It covers all needed context for an 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 coverage is 100%. The description repeats the parameter info by mentioning 'Defaults to the server's configured API_DOCS_URL,' which is already in the schema's description. No additional meaning beyond the schema.

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 it retrieves 'Top-level API metadata: title, version, description, servers, global security, and counts.' It distinguishes itself from siblings like get_endpoint or list_endpoints by focusing on the overarching API overview.

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?

The description advises 'Start here on an unfamiliar API,' providing clear usage context. It does not explicitly list when not to use or alternatives, but the sibling tools (e.g., get_auth, get_endpoint) cover other aspects, making the guidance adequate.

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

Deploy Server

Other Tools