save_active_document

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

The description discloses key behaviors: silent save (no UI dialogs), only works if document has filename, and raises specific errors. It also details return dict fields including error/warning bitmasks.

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?

The description is well-structured with clear sections and alternating languages, but the bilingual nature makes it slightly longer than necessary. Each sentence adds value.

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 no annotations and no output schema, the description covers all necessary context: purpose, usage, behavior, return format, and error handling. It is complete for a tool of this complexity.

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?

There are no parameters, and the baseline for 0 params is 4. The description adds value by explaining behavior and return values, but no parameter semantics needed.

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 saves the active SolidWorks document silently, equivalent to Ctrl+S, and explicitly mentions it works on parts, assemblies, or drawings. It distinguishes itself from save_as for new documents.

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?

The description explicitly says the tool should be used when the document already has a filename, and for new documents it instructs to use save_as. It also notes prerequisites and error conditions.

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