create_report_snapshot

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

Discloses immutability, write-once, non-idempotent behavior, and return values (ID, timestamp, hash, URLs). Lacks details on auth/rate limits but is thorough for a read-only-like creation tool.

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?

Concise paragraph with front-loaded purpose. Contains multiple useful details without being verbose. Could be slightly more structured but effective.

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?

Given no output schema, description fully explains return values and behavior. Covers purpose, usage, parameters, and outcomes. No gaps identified for this tool's complexity.

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?

Schema covers all parameters (100% coverage). Description adds context: format parameter controls initial return but both JSON and Markdown URLs are returned, and note about non-idempotent POST.

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?

Clearly states it creates an immutable snapshot of the Everything Report. Distinguishes from siblings like get_everything_report and get_report_snapshot by emphasizing immutability and write-once nature.

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?

Explicitly says when to use (when stability is needed) and when not (use get_report_snapshot to read back). Mentions use cases: tickets, audits, compliance, LLM citations. Provides alternative tool recommendation.

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