Skip to main content
Glama
kardaj

openapi-tools-mcp

by kardaj

Spec List

spec_list

List keys inside a chosen OpenAPI specification section from a local file path or remote URL, optionally filtered by tag or glob pattern. Supports headers and cached remote specs.

Instructions

Enumerate keys within a spec section from a local path string or URL source object. For remote specs, pass spec_path as {"url": "https://example.com/openapi.yaml", "headers": {"Header-Name": "value"}}; headers are optional, only http/https URLs are supported, and successful downloads are cached in memory for 15 minutes with stale fallback on network errors or HTTP 5XX refresh failures.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionYes
spec_pathYes
filter_by_tagNo
filter_by_globNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.6/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does substantial work: it discloses an in-memory 15-minute cache, stale fallback on network errors, and 5XX refresh-failure behavior, plus the http/https-only restriction. It omits read-only confirmation, permission requirements, and return/error shape, but the caching and failure semantics are unusually rich.

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?

Front-loaded with the core action, then the remote-spec mechanics in one dense sentence with no filler. It drifts toward run-on length in the caching clause but every clause conveys actionable detail.

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 4-parameter tool with no annotations and no output schema, the description covers the fetch mechanics well but leaves the filtering parameters and the expected return ('keys' format) unexplained. It is adequate to invoke the tool, but an agent would have to guess at filter semantics.

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 0% across 4 parameters, so the description must compensate. It documents spec_path thoroughly (string path vs. {url, headers} object with optional headers), but says nothing about 'section', 'filter_by_tag', or 'filter_by_glob', leaving three parameters undocumented in both schema and text.

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 and resource: 'Enumerate keys within a spec section,' which is distinguishable from spec_get (retrieval) and spec_info (metadata) even without naming them. It is clear what the tool does, but the description never explicitly contrasts itself with the sibling tools.

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?

Usage is implied rather than stated: the tool is for listing keys in a section. The remote-source paragraph explains how to supply a URL, which is useful operational guidance, but there is no when-to-use-this-vs-spec_get/spec_info guidance and no exclusions or 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