Skip to main content
Glama
Swagger MCP Server

Swagger MCP Server

by tsiva18

search_api

Search API endpoints by module, path, summary, or operation ID to quickly locate relevant operations in Swagger/OpenAPI specifications.

Instructions

Search API endpoints by module, path, summary or operation ID.

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_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesKeyword or search query

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure and does not meet it. It never says the operation is read-only, whether matching is substring/fuzzy/case-insensitive, whether fields are OR'd or AND'd, or whether results are capped or paginated.

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 with no filler; the searchable fields are enumerated compactly rather than buried in prose. Nothing in it could be cut without losing information.

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 one-parameter lookup tool with no output schema, the definition is serviceable but thin: match semantics, result limits, and how results relate to the sibling detail/schema tools are all unstated. Adequate to invoke, not adequate to predict behavior.

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 schema already documents the single query parameter at 100% coverage, so the baseline would be 3. The description earns above baseline by naming the four fields the query is matched against (module, path, summary, operation ID), which is real meaning not present in the schema's generic 'Keyword or search query'.

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?

States a specific verb (search) and resource (API endpoints), plus the fields searched: module, path, summary, operation ID. That is enough to distinguish it from get_api_details, get_api_schema and list_api_modules without opening any schema, though it never explicitly contrasts itself with those siblings.

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?

No when-to-use or when-not-to-use guidance is given. An agent must infer that this is the discovery/lookup tool and that list_api_modules or get_api_details cover other needs; the description never states that or gives any prerequisite.

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