Skip to main content
Glama

Explain the scan in plain English

explain
Read-onlyIdempotent

Summarize scan findings in plain English using your local model at CODE_GUARDIAN_LLM_URL; sends only results, never source, and leaves scores unchanged.

Instructions

Runs scan, then asks the local model at CODE_GUARDIAN_LLM_URL for a plain-English summary. Sends the findings only (no source). The score never changes; without a model it returns a note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
goalNogoal contract file; default PATH/code-guardian.goal.toml if present
pathYesthe project directory to read

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing the external dependency (CODE_GUARDIAN_LLM_URL), the data egress boundary (findings only, no source), that the score is not modified, and the degradation path (returns a note without a model). These are exactly the behavioral traits an agent cannot get from readOnlyHint/idempotentHint.

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?

Three tight sentences, front-loaded with the core action and followed by the two constraints that matter (what is sent, what happens without a model). No filler.

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 still conveys the return shape (plain-English summary, or a note when no model is configured) and the safe-read nature. Minor gap: it doesn't hint at summary length/format or latency from the model call.

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 coverage is 100% with only 2 params, so the schema already carries the parameter semantics (including the goal-contract default). The description adds no parameter-level detail, so baseline 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?

Specific verb+resource: it runs the scan and asks a local model for a plain-English summary of the findings. This implicitly distinguishes it from the sibling `scan` (raw scan output vs. narrated explanation), though it never names the sibling explicitly.

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 rather than stated: an agent can infer this is the 'explain the scan' path versus the plain `scan` sibling, but there is no explicit when-to-use/when-not or named alternative. Adequate but leaves selection logic to inference.

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