Skip to main content
Glama
OpenCyber Harness
by mitkox

oc_openapi_inspect

Read-onlyIdempotent

Extract operations from a JSON OpenAPI document at a URL or engagement-relative path to inventory API endpoints, avoiding manual grep, jq, or Python parsing.

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.

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": {
      "engagement_id": "<engagement_id>",
      "source": "<source>"
    },
    "name": "oc_openapi_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceYes
timeoutNo
engagement_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, and the description is consistent with a safe read (openWorld matches fetching from a URL). Beyond annotations it adds only that the source may be a URL or engagement-relative path; it says nothing about behavior on malformed specs, timeouts, or failures.

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 sentences, zero filler, with the core action and accepted inputs front-loaded before the preference statement. Every clause earns its place.

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?

The output schema and annotations cover return shape and safety, and the source format is explained, so the core path is covered. Gaps remain around what engagement_id scopes and how invalid or unreachable documents are handled, which matters for a tool that fetches remote content.

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?

Schema description coverage is 0%, so the description must carry parameter meaning. It clarifies only `source` (URL vs engagement-relative path); `engagement_id` and `timeout` receive no explanation at all, so most parameters remain opaque.

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', with scope on accepted sources (URL or engagement-relative path). It distinguishes itself from generic tooling (grep, jq, Python) rather than from its closest sibling oc_openapi_audit, so sibling differentiation is only partial.

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?

Gives explicit when-to-use guidance: 'Prefer this over grep, jq, or Python when the task is OpenAPI operation inventory.' There are no when-not-to-use conditions and no mention of oc_openapi_audit as the alternative for auditing rather than inventorying, but the positive routing is clear.

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