about

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

The description discloses return content and token size (~800 tokens). No annotations provided, but as a read-only metadata tool, the description covers key behavioral aspects. No harmful side effects implied.

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: three sentences, front-loaded with purpose, usage, and preference. Every sentence adds useful information without redundancy.

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?

No output schema, but the description enumerates return components (metadata, provenance, etc.) and mentions token count. Sufficient for a no-parameter info 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?

No parameters exist, so baseline is 4. The description adds value by specifying what the result contains, which compensates for the lack of param details.

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 clearly states the tool returns structured JSON with specific metadata components (provenance, fingerprint, freshness, security posture). It distinguishes from sibling 'version_info' by noting preference when machine-readable metadata is needed.

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 states when to use: 'verify data currency and coverage before relying on results.' Also provides alternative: 'Prefer this over version_info when you need machine-readable metadata.'

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