Skip to main content
Glama
Sign In
swagger-mcp

swagger-mcp

by emreycolakoglu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Search schemas

search_schemas
Read-only

Search OpenAPI schema names, properties, and descriptions by substring, with results ranked by relevance.

Instructions

Substring search over schema names, property names, and descriptions. Returns matches ranked by relevance.

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": {
      "query": "<query>"
    },
    "name": "search_schemas"
  }
}

Input Schema

NameRequiredDescriptionDefault
specNoURL or local path of the OpenAPI/Swagger spec. Defaults to the server's configured API_DOCS_URL.
queryYesCase-insensitive substring to match.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint=true, so the description is not required to repeat that. The description adds that it performs substring search and returns ranked results, providing useful behavioral context beyond 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?

Two concise sentences front-loaded with key action and output. No unnecessary 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?

The description sufficiently covers the tool's purpose and output (ranked matches). Since there is no output schema, the description adequately explains return behavior.

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% with both parameters described. The description mentions substring search but does not add significant new meaning beyond the schema descriptions (e.g., 'Case-insensitive substring to match').

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 performs substring search over schema names, property names, and descriptions, and returns ranked matches. This distinguishes it from siblings like list_schemas and search_endpoints.

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

Usage Guidelines3/5

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

The description describes what the tool does but provides no guidance on when to use it versus alternatives. It does not mention when not to use it or specify prerequisites.

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