get_file_preview_info

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

No annotations provided, so description is the sole source. It does not disclose requirements (e.g., does a preview request need to exist?), side effects, or error conditions. While 'get' implies read-only, this is not explicitly stated.

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?

Single sentence, front-loaded with key information. Every word is meaningful; no 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?

Does not explain how this tool fits with related tools like 'create_file_preview_request' and 'get_file_preview_info_by_version'. Output schema exists but is not referenced; no mention of what happens if no preview is available. Incomplete for an agent to use correctly without additional knowledge.

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 has one parameter 'file_id' with 0% description coverage. The description does not explain the parameter's purpose or any constraints beyond the schema. Although the parameter name is self-explanatory, the description fails to provide additional context such as format or required state.

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 action ('Get preview info') and the specific outputs ('status and URL') for a file. It distinguishes from sibling tools like 'create_file_preview_request' and 'get_file_preview_info_by_version' by focusing on retrieval of existing preview info.

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?

No guidance on when to use this tool versus alternatives, such as 'get_file_preview_info_by_version' or 'get_file_download_url'. No prerequisites like needing to first create a preview request are mentioned.

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