describe_file

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

Discloses read-only nature, no token cost from body, no auth/rate limits. Does not detail error handling or invalid id behavior, but sufficient for basic transparency.

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, lists returned info, operational context, usage guidance, and parameter note. No redundant content.

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 purpose, return details, usage scenario, and parameter hint. Missing error handling or id format details, but adequate for a simple tool without output schema.

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 describes 'id' as number; description adds constraint 'must be a valid integer file ID', providing additional validation guidance beyond schema.

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 returns file metadata without content, listing specific attributes. Implicitly distinguishes from siblings like read_file, list_tags, get_history, find_related.

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 advises using this tool to avoid chaining multiple reads. Mentions local operation with no auth/rate limits. Lacks explicit when not to use, but context is clear.

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