clash.config.apply_transaction

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

Discloses the entire sequence: snapshot creation, file writing, reload attempt, health checks, and automatic rollback on failure. No contradictions with missing annotations.

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?

Single sentence that front-loads the main action and efficiently lists all steps without fluff.

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?

Covers all major aspects of the apply transaction—snapshot, write, reload, health checks, rollback—despite no output schema.

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?

Adds meaningful context beyond the schema: confirmed must be true, workspaceId must come from create_workspace and be validated.

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 applies a validated workspace's changes to the persistent config file, distinguishing it from sibling tools like preview_change, validate_change, and rollback by describing the full apply action.

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?

Explicitly mentions that light confirmation is required (confirmed=true) and that the workspace must be validated, but could be more explicit about prerequisite steps like validate_change.

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