export_document

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

Without annotations, description bears full behavioral burden. It explains it exports to file on disk and lists supported formats, but does not disclose error handling, file overwrite behavior, or performance implications. Adequate but not comprehensive.

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 concise, front-loaded with purpose, and includes a well-structured Args section. Every sentence adds value 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?

Given 3 parameters and no output schema, description covers core behavior and parameter details. However, it omits return value (file path) and potential error cases (e.g., invalid view name), leaving minor gaps.

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 description coverage is 0%, so description adds crucial meaning. It explains each parameter with defaults, usage, and context (e.g., resolution ignored for PDF/DWG), fully compensating for the lack of schema descriptions.

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 it exports a Revit view or sheet to PDF or image format. Specific verb 'Export' and resource 'Revit view or sheet' with supported formats listed. Distinguishes from sibling export tools like export_ifc and export_room_data by focusing on view/sheet to PDF/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?

Describes when to specify a view name and that it falls back to the active view. However, lacks explicit guidance on when to use this tool versus other export tools like export_ifc or export_room_data, and does not mention prerequisites or limitations.

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