Skip to main content
Glama
OpenCyber Harness
by mitkox

oc_openapi_audit

Audit OpenAPI JSON from URLs or engagement-relative paths for operations, auth coverage gaps, path-parameter issues, sensitive fields, and transport risks, saving evidence-backed findings.

Instructions

Audit an OpenAPI JSON document from a URL or engagement-relative path for operation inventory, declared authentication coverage, path-parameter consistency, sensitive fields, and transport review items. Results are evidence-backed leads and are persisted in the engagement.

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_audit"
  }
}

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?

Annotations declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false; the description adds the key behavioral fact that results are persisted in the engagement and are 'evidence-backed leads' rather than definitive findings. That is real context beyond the hints, but it omits whether repeated runs duplicate persisted records, what network access/rate behavior to expect, and what the timeout does.

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?

Two sentences, front-loaded with the verb and target, then the audit dimensions, then the outcome. Dense but nearly every clause carries information; the five-item enumeration is long but scopes the tool precisely.

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?

The presence of an output schema removes the need to describe return values, and the description covers target semantics and persistence side effects for a moderate-complexity tool. Remaining gaps are the undocumented timeout behavior and the absence of sizing/cost expectations for fetching a remote document.

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 carry the load; it does explain that 'source' accepts a URL or an engagement-relative path, which is genuine added meaning. However, 'timeout' (nullable, default null) and 'engagement_id' are never explained, leaving two of three parameters undocumented anywhere.

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 uses a specific verb+resource ('Audit an OpenAPI JSON document') and enumerates the exact review areas: operation inventory, declared auth coverage, path-parameter consistency, sensitive fields, and transport items. It is clearly distinct in substance from a generic 'inspect' tool, though it never explicitly distinguishes itself from the sibling oc_openapi_inspect.

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 by the enumerated audit categories and by stating the source can be a URL or engagement-relative path, which hints at the two invocation contexts. There is no explicit 'use this when...' or 'use inspect instead when...' guidance, and no prerequisites or exclusions are given.

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