Show BIM File

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

Annotations already declare readOnlyHint, destructiveHint, and idempotentHint. Description adds minor value by specifying the API endpoint (GET /rest/v1.0/bim_files/{id}) and module (Preconstruction > BIM), but does not disclose additional traits like auth needs or error handling. No contradiction with annotations.

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?

Description is three concise sentences with no waste: purpose, usage instruction, return type, and endpoint context. Front-loaded with most important information; every sentence earns its place.

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?

For a simple read tool with full schema and annotations, the description is largely complete. It explains return type (JSON object) and required parameters. Missing minor details like behavior on non-existent ID, but overall sufficient given schema richness.

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%; all 5 parameters are documented in the schema. Description only reiterates required parameters (id, project_id) and adds no new meaning beyond what the schema provides. Baseline 3 is appropriate.

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 a single BIM file item with full details, using specific verb 'Return' and resource 'BIM File item'. It distinguishes itself from sibling tools like list_bim_files and other show_* tools by specifying 'single BIM File item'.

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?

Description implies usage for fetching a specific BIM file by identifier but does not explicitly state when not to use or mention alternatives like list_bim_files. Provides required parameters context but lacks exclusion guidance.

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