Skip to main content
Glama

data-api-code

openapi_spec_inspect

Inspect an OpenAPI 3.x / Swagger 2.0 JSON specification for paths, HTTP methods, security schemes, missing descriptions, and schema count.

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": "openapi_spec_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
textNo
filePathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations at all, the description carries the full burden. It usefully discloses the contents of the report (which is close to a return-value contract), and 'inspect' implies a read-only, non-mutating operation, but it never says the operation is read-only, never addresses the two input modes (inline text vs file read), and says nothing about error behavior or output shape.

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 enumerates concrete inspection targets with no filler. Nothing could be removed 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 two-parameter, no-annotation, no-output-schema tool, the description covers what gets inspected well but leaves the most decision-relevant detail unspecified: how to supply the spec and what the report looks like. An agent can identify the tool's purpose but may still guess wrong on invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Both parameters (text, filePath) have 0% schema description coverage, and the description does not mention either one. Whether they are mutually exclusive, which takes precedence, or whether filePath is resolved relative to a workspace is left entirely ambiguous, so the description fails to compensate for the coverage gap.

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?

Uses a specific verb ('Inspect') with a precisely scoped resource (OpenAPI 3.x / Swagger 2.0 JSON spec) and enumerates the facets reported: paths, HTTP methods, security schemes, missing descriptions, schema count. That scope alone separates it from graphql_schema_inspect and json_schema_validate_and_mock, though it never names an alternative explicitly.

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 when-to-use or when-not guidance; the agent must infer that this is the tool for a static spec audit rather than validation or mocking. No prerequisites (e.g., spec must be valid JSON) or exclusions are stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources