set_simvar

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

No annotations are provided, so the description bears the full burden. It states 'Write' indicating mutation, but fails to disclose error handling, side effects, or behavior when the SimVar is not settable.

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 very short (one sentence plus a note), but it lacks structure and omits important details. Conciseness is not necessarily effective here.

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 tool performs a write operation with no annotations, the description is insufficient. It does not explain return values, potential errors, or what happens on failure, and the output schema is present but not leveraged.

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 description coverage is 0%, so the description must compensate. It only gives an example for 'name' and no description for 'value' or format, adding negligible meaning beyond the schema.

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 writes a settable SimVar, with an example (AUTOPILOT_HEADING_LOCK_DIR). It distinguishes from get_simvar (read) and from specific autopilot_set_* tools by being a generic setter for any settable SimVar.

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 advises to 'Check settable in the catalog', implying the tool should only be used for settable SimVars, but it does not explicitly contrast with sibling tools like autopilot_set_heading or provide when-to-use guidance.

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