Skip to main content
Glama

workbench_report

Generate a Markdown investigation report with findings, evidence index, engine coverage, and verification limits, without claiming zero bugs when no findings were recorded.

Instructions

Write a new Markdown investigation report with findings, evidence index, engine coverage and verification limitations. Never claims there are no bugs because no finding was recorded.

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": {
      "case_id": "<case_id>"
    },
    "name": "workbench_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
case_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=true, so the write nature and safety profile are covered. The description adds one genuinely useful behavioral contract (it will never assert 'no bugs' from an empty finding set), but omits whether it overwrites a previously written report, where the Markdown is persisted, and what the call returns.

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 action and artifact, and the second sentence carries a non-obvious behavioral constraint rather than padding. Nothing is redundant, though a short clause on overwrite behavior would have been worth the extra words.

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?

This is a mutating, open-world tool with one undocumented parameter and no output schema, so the description must carry the remaining load. It explains what content the report contains but not whether an existing report is replaced, where the file lands, or what the caller receives back (path, id, confirmation) — gaps an agent needs to call it safely twice.

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% and the description never mentions case_id, so it adds no meaning beyond the schema. Mitigating factor: a single required UUID parameter is largely self-explanatory from its name and format, so the gap is small rather than crippling.

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 and artifact ('Write a new Markdown investigation report') and enumerates its sections (findings, evidence index, engine coverage, verification limitations), which distinguishes it from sibling tools like workbench_record_finding or workbench_close_case. It stops short of explicitly contrasting with those siblings, but the purpose is unambiguous.

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: the agent must infer this is a terminal/authoring step after findings are recorded. There is no explicit 'use this when X, use workbench_close_case instead when Y' routing, and no stated preconditions (e.g., whether the case must already have findings).

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