Skip to main content
Glama

Render Proofspec Report

proofspec_render

Evaluates a specification and renders it as JSON, Markdown, standalone HTML, Mermaid, or SARIF for review and reporting.

Instructions

Evaluate a specification and render JSON, Markdown, standalone HTML, Mermaid, or SARIF.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proofspec_render"
  }
}

Input Schema

NameRequiredDescriptionDefault
configNo
formatNomarkdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/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 and gives little: it does not say whether evaluation failure aborts rendering, whether the operation is read-only or writes files, whether auth is needed, or what happens to the report on error. The enumeration of five formats is the only real behavioral disclosure beyond the title.

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 no filler and no repetition of the title. It is efficiently sized, though the extreme terseness leaves no room for the missing guidance noted elsewhere.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter tool with zero schema description coverage, no annotations, and no output schema, the description should explain the config input and the evaluation semantics. Neither is covered, so an agent cannot confidently construct a call beyond picking a format.

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. It partially does by enumerating exactly the five format values that match the format enum, but it says nothing at all about the config parameter, whose meaning and expected syntax remain opaque in both schema and description.

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 names a specific verb pair (evaluate and render) and the resource (a specification), plus the exact set of output formats. An agent can tell this is the rendering tool rather than a checking tool, though nothing in the text distinguishes it explicitly from siblings like proofspec_check or proofspec_validate.

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?

There is no statement of when to reach for this tool versus proofspec_check, proofspec_explain, or proofspec_validate, and no prerequisites or exclusions. The only implied guidance is that it produces formatted output, which the agent must infer from the format list.

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