Skip to main content
Glama
Sign In
openapi-explorer-mcp

openapi-explorer-mcp

by deadrime
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Describe an endpoint

api_endpoint
Read-only

Inspect a specific endpoint's parameters, request/response shapes, security alternatives, danger level, and URL to assess API interactions.

Instructions

Parameters, request and response shapes (compact, depth-limited), danger level, security alternatives and URL of one endpoint.

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": {
      "endpoint": "<endpoint>"
    },
    "name": "api_endpoint"
  }
}

Input Schema

NameRequiredDescriptionDefault
modeNooutline: a compact pseudo-type; json: the schema with $refs resolvedoutline
depthNoHow deep nested schemas are expanded
endpointYes"METHOD /path", a path with a single operation, or a unique operationId

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.2

TDQS

B3.2/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes the tool is non-destructive. The description adds output-related context such as 'danger level' and 'security alternatives', but it does not address tool-specific behaviors like rate limits or auth requirements. This adds some value beyond the annotation without contradicting it.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, compact sentence that is front-loaded with the main purpose. It lists the output aspects without wasted words. It could mention the input format for the endpoint, but the schema covers that, keeping the text appropriately lean.

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?

With only 3 parameters, all fully described in the schema, and a read-only annotation, the description covers the tool's purpose and output scope reasonably well. The output schema is absent, so the description's enumeration of response aspects is helpful. It lacks explicit alternatives but is otherwise complete enough for straightforward invocation.

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 each parameter (endpoint, mode, depth) already documented including enums and defaults. The description's mention of 'compact, depth-limited' hints at the effect of depth/mode, but it does not add significant new meaning beyond the schema baseline.

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 states a specific resource ('one endpoint') and the details it provides: parameters, request/response shapes, danger level, security alternatives, and URL. While it does not explicitly differentiate this tool from siblings like api_schema or api_get, the 'one endpoint' scoping and the list of output aspects make the purpose clear.

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?

The description gives no guidance about when to use this tool versus the alternatives. It does not mention search, spec-level information, or other tools, and there are no usage prerequisites or exclusions. An agent must infer from the sibling names, which is insufficient.

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