Skip to main content
Glama
Sign In

api-evangelist

by com.apievangelist
OverviewDiscussionsAdmin

governance_report

Read-only

Turn Spectral findings into a self-contained HTML governance report — severity summary, grouped by rule, framed toward progress.

Input Schema

NameRequiredDescriptionDefault
contextNoOptional: why you are asking. One sentence — the task you are trying to complete, or what you expect to get back. Never included in the answer and never used to rank; it is read only when a result turns out to be wrong, which is when knowing the intent is what makes the report actionable.
resultsYesSpectral findings to render. An array, or the `{ results: [...] }` object a run returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / context
      Added value: +{
+  "description": "Optional: why you are asking. One sentence — the task you are trying to complete, or what you expect to get back. Never included in the answer and never used to rank; it is read only when a result turns out to be wrong, which is when knowing the intent is what makes the report actionable.",
+  "type": "string"
+}
  2. Changed1 schema field changed
    • addedInput schema / properties / results
      Added value: +{
+  "description": "Spectral findings to render. An array, or the `{ results: [...] }` object a run returned.",
+  "type": [
+    "array",
+    "object"
+  ]
+}
  3. Added

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, covering the safety profile, so the bar is lower. The description adds genuinely useful behavior beyond that: the output is a 'self-contained' HTML document and contains a severity summary grouped by rule. It omits pagination/size behavior, but for a pure renderer this is solid added context.

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 that names input, output format, and report contents with no wasted clauses. 'framed toward progress' is slightly soft/vague but does convey the report's framing, so it mostly earns its place.

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?

With no output schema, the description carries the burden of describing the return value and does so ('self-contained HTML ... severity summary, grouped by rule'). Input semantics are fully covered by the schema. Only usage guidance and size/edge-case behavior are missing, which keeps it short of a 5.

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 100% and both parameters are documented at length in the schema, including the non-obvious 'context' field. The description adds no parameter-level detail beyond what the schema already provides, so the baseline of 3 applies.

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 (turn) and resource (Spectral findings) with a named output artifact (self-contained HTML governance report) plus its internal structure. This distinguishes it from generator siblings like api_scorecard or govern_estate, though it does not explicitly name an alternative. Clear and concrete, if not sibling-differentiating by comparison.

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

Usage Guidelines2/5

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

The description never states when to reach for this tool versus the many other report-ish siblings (api_coverage, api_scorecard, govern_estate) or what input state is required. 'framed toward progress' hints at intent but is not an actionable condition. No exclusions or prerequisites are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All api-evangelist toolsInspect
Try in Browser
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources