Attest a file

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

Discloses key behavior: file is streamed and never sent, server timestamps and returns signed attestation. With no annotations, description covers privacy and output adequately, though missing details on error handling or rate limits.

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?

Two sentences, no filler. Front-loaded with main action and key constraints (streamed, credential needed). Every sentence adds value.

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?

Covers auth, privacy, output (signed attestation), and optional metadata. No output schema, but description sufficiently describes return. Complete for a file attestation tool.

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 coverage is 100%, baseline 3. Description adds value by explaining that optional metadata (titolo/autore/anno/note) is bound to the signature, going beyond schema descriptions.

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 the tool computes SHA-256 fingerprint and attests it with timestamp and signed attestation. Distinguishes from siblings like 'verify_file' and 'authorize' by specifying the core action.

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 mentions prerequisite credential (run 'authorize' first or set IMGAUTH_API_KEY). Provides context on when to use, though does not explicitly state when not to use.

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