Skip to main content
Glama

Index OpenAPI operations

bpj_index_openapi_operations
Read-onlyIdempotent

Extract methods and operation IDs from an OpenAPI 3 JSON paths object and spot missing or duplicate IDs.

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": {
      "document": "<document>"
    },
    "name": "bpj_index_openapi_operations"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world, so the safety profile is covered. The description adds that it detects anomalies (missing/duplicate IDs), but says nothing about the response shape or what happens with malformed or oversized input. With annotations carrying the safety burden, a 3 fits.

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?

A single front-loaded sentence with the primary action first and the diagnostic purpose second; no filler. It is dense but readable, and nothing in it is redundant with the annotations.

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?

With one required parameter, no output schema, and no nested objects, the tool is simple, but the description leaves the return value unexplained and never mentions the size limit on the document. It is adequate for an agent to attempt a call but not complete enough to predict the result.

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%, so the description must compensate, and it does partly clarify that the input is the paths object of an OpenAPI 3 document (the schema only says 'OpenAPI 3 JSON document'). However, it omits the meaningful 9500-character maxLength constraint and does not clarify the string-encoded JSON format of the parameter.

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?

Names a specific verb (Extract) and precise resource (methods and operation IDs) plus the input shape (OpenAPI 3 JSON paths object), and adds a secondary function (spotting missing or duplicate IDs). It is unambiguous on its own; it simply offers no differentiation from a named alternative.

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 only implied by the phrasing – an agent can infer this is for validating/indexing an OpenAPI paths object, and the 'missing or duplicate IDs' clause hints at an audit use case. There is no explicit when-to-use, when-not, or pointer to an alternative tool for related tasks.

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.