Save Document

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

Beyond annotations (idempotent, non-destructive), the description adds crucial details: the prerequisite for in-place saves (document must already have a file) and the conditional use of 'format' only when 'path' is given. This provides behavioral context annotations alone cannot convey.

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 concise, front-loading the core action in the first sentence, and using an Args block for parameter details. Every sentence adds value, with no redundancy or unnecessary text.

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 the absence of an output schema, the description omits any mention of return values, success/failure indicators, or error conditions. While the core behavior is covered, this gap reduces completeness for a tool that performs a write operation.

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 input schema has 100% coverage with descriptions for both parameters. The description reiterates the same information without adding new semantic details, so it meets the baseline for parameter clarity but does not go beyond.

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 'Save the active document', using a specific verb and resource. It distinguishes two modes (in-place vs. save a copy) and provides context that differentiates it from sibling tools like illustrator_close_document or illustrator_export_document.

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 explains when to use the tool with and without a 'path' parameter, giving clear context for each scenario. However, it does not directly compare to alternatives like illustrator_export_document or advise when not to use this tool.

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