get_d_max_gain

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

With no annotations, the description clearly explains the parameter's effect on D gain rise behavior and includes its type, range, and default in brackets. It does not mention side effects or permissions, but for a read-only tool this is sufficient.

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?

Two sentences plus a compact bracket notation. Front-loaded with purpose, no unnecessary words. Every sentence provides essential information.

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 simple getter with no output schema, the description covers what the parameter does, when to modify it, and its constraints. It could mention if the value is live or cached, but overall is complete.

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 tool has zero input parameters, so schema coverage is 100%. The description adds value by explaining the meaning and range of the output value (UINT8, 0–100, default 37), which is more than the schema provides.

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 retrieves the d_max_gain parameter and explains its function: 'Controls how aggressively D rises from base D toward d_max on sharp moves.' It distinguishes itself from sibling tools like get_d_max_pitch or get_d_max_roll by focusing on this specific D gain behavior.

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?

Provides practical guidance: 'Default is suitable; reduce if D boost causes propwash on move initiation.' This tells when to adjust the value, though it does not explicitly compare to alternative tools or state when not to use it.

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