Search SimVars

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior. The description adds useful behavioral context beyond the annotations by noting that results include units, settable status, and pagination, which helps the agent understand what to expect from the call.

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 compact and front-loaded: the main action is stated in the first sentence, followed by return-value purpose and pagination detail in two short sentences. Every sentence earns its place with no redundancy or filler.

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 search tool with a detailed input schema, a present output schema, and rich annotations, the description is complete. It explains the core operation, the key returned fields, and pagination, while leaving parameter formatting and response-shape details to the schema where they are already well documented.

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 100%, with each parameter already described clearly, including examples for keyword and category. The description adds no new parameter-level detail, but it reinforces the overall purpose of returning units and settable flags, which is enough to meet the baseline for high schema coverage.

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 opens with a specific verb and resource: 'Search the SimVar catalog by keyword.' It clearly distinguishes this tool from sibling get/set and event/LVar search tools by stating it returns units and settable status, which directly supports msfs_get_simvar and msfs_set_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 gives clear context for when to use the tool: before calling msfs_get_simvar or msfs_set_simvar, to obtain the right arguments. It does not explicitly list alternatives or exclusions, but the SimVar-specific scope and stated purpose make the intended use clear.

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