Skip to main content
Glama

websex_openapi_inspect

Extract operations from a JSON OpenAPI document at a URL or engagement-relative path, replacing grep, jq, or Python for OpenAPI operation inventory tasks.

Instructions

Extract operations from a JSON OpenAPI document at a URL or engagement-relative path. Prefer this over grep, jq, or Python when the task is OpenAPI operation inventory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourceYes
engagement_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/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 behavioral burden, yet it only says what is extracted, not how. It never states that this is a read-only/network-fetching operation, whether the source is fetched or resolved locally, or any auth/limit behavior, which matters for a tool that takes a URL.

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 tightly written sentences, front-loaded with the action and resource followed by the routing guidance. No filler.

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?

An output schema exists, so return values need not be explained, and the source-routing detail is present. Still missing is any behavioral framing (read-only, fetch vs local, failure modes) and the meaning of engagement_id, leaving a gap for a two-required-param tool with zero annotations.

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 0%, so the description must compensate. It clarifies that 'source' accepts either a URL or an engagement-relative path, which is genuinely useful, but leaves 'engagement_id' and its scoping role entirely undocumented.

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: 'Extract operations from a JSON OpenAPI document'. The scope (operation inventory) is clear. However, it never distinguishes itself from its closest sibling websex_openapi_audit, so an agent cannot tell inspect vs audit apart from the text alone.

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

Usage Guidelines4/5

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

'Prefer this over grep, jq, or Python when the task is OpenAPI operation inventory' gives an explicit condition and names concrete alternatives. It stops short of the 5-bar because it does not address when NOT to use it or how it relates to the sibling audit tool.

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