reload_document

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

Even with no annotations, the description fully discloses behavior: it closes the stale in-memory copy and reopens from disk, including potential failure modes ('document not loaded, no associated file'). It also implies side effects by noting it reopens from disk, which covers the possibility of discarding unsaved changes without explicit warning, but that is inherent to the described action.

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?

Well-structured with a summary, usage guidance, Args section, Returns section, and a JSON example. Every sentence adds value, and it is appropriately sized for the tool's simplicity.

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?

Despite no output schema, the description covers return values ('A message confirming the document was reloaded, or describing the failure'). With one parameter and clear behavior, the description is fully complete for an agent to invoke correctly.

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?

The schema provides only a generic string parameter, but the description adds clear meaning: 'doc_name: The name of the open document to reload. Must match the name shown by list_documents.' This fully compensates for the 0% schema coverage.

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's purpose: 'Close and re-open a document to pick up external file changes.' This is a specific verb-resource combination that distinguishes it from siblings like list_documents or edit_object, which do not perform reload actions.

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?

Provides explicit usage context: 'Use this AFTER the document's .FCStd file has been modified by something outside of FreeCAD's GUI process' and explains why (the GUI is unaware of on-disk changes). It also clarifies when not needed implicitly by describing the specific scenario.

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