veritas_nafe_scan

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

Despite no annotations, the description discloses the return JSON structure and the side effect of auto-sealing violations to the audit ledger. It could mention whether the tool is read-only or have rate limits, but it covers the key behavioral aspects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with no wasted words: first sentence states action and signatures, second gives usage and purpose, third covers output and side effect. Each sentence earns its place.

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

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

The description covers purpose, usage, output format, and side effect. It compensates for the lack of output schema by listing the return fields. However, it doesn't mention size limits or error conditions, which would make it more complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'text' is well-described in both the input schema and the main description, which adds examples (commit messages, incident reports) beyond the schema's brief example. This enriches the parameter meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states it scans text for four specific NAFE failure signatures, with a clear verb and resource. This distinguishes it from sibling tools, which are primarily gates or execution tools, making it a unique scanning/analysis tool.

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

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

The description gives explicit context: 'Use this on commit messages, PR descriptions, or incident reports'. While it doesn't list alternatives or when not to use, the context effectively guides the agent to appropriate use cases.

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