apply_plan

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

No annotations provided, so description bears full burden. It states 'On any failure nothing is written' and explains save modes, but lacks details on permissions, rate limits, or other side effects beyond the save operation.

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 a coherent single paragraph with front-loaded purpose. It covers essential details without unnecessary words, though a bullet structure could improve readability.

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?

For a 5-param tool with no output schema or annotations, the description explains return fields, save modes, and failure behavior. Missing deeper context about DocumentPlan format, but acceptable given tool specificity.

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%, so description must compensate. It explains saveMode options and newName context, but does not describe connectionId, documentId, or planJson parameters beyond their names.

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 applies a DocumentPlan JSON to a document and saves through the provider. It lists return fields and differentiates save modes, distinguishing it from siblings like preview_plan.

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 explains when to use each saveMode (NewVersion, NewDocument, Replace) with clear behavior. However, it lacks explicit comparison with sibling tools like preview_plan or 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.