get_revit_view

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

No annotations provided, so description carries full burden. States 'export' but doesn't clarify if it's read-only (implied but not explicit), or disclose side effects, permissions, or output file details. Average 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?

Single sentence, no superfluous words. Concise but lacks structured details that would improve usability (e.g., expected output format).

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?

Tool has low complexity (1 param, no output schema, no annotations), but description omits crucial details: output format (file path, base64?), how to retrieve the image, and error conditions. Incomplete for practical invocation.

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 0%; description adds no meaning to the parameter 'view_name'. Does not indicate valid values (e.g., must match a view from 'list_revit_views') or format. Only the parameter name is conveyed.

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?

Description clearly states the verb 'export', resource 'Revit view', and outcome 'image'. It effectively distinguishes from siblings like 'list_revit_views' (listing vs. export) and 'get_current_view_info' (info vs. image).

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 guidelines on when to use this tool vs. alternatives. Missing context on prerequisites (e.g., open document) or when to prefer other tools like 'get_current_view_info' or 'open_document'.

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