I2C Timing & Pull-Up Calculator

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

Annotations already indicate readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description reinforces this by describing a pure computation and adds context about the estimate nature and verification recommendation, which is valuable beyond structured fields.

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 well-structured with clear sections for Args, Returns, and an Example. It is reasonably concise, though slightly verbose in listing Args compared to schema. Every sentence adds value.

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 complexity of I2C timing calculations and the presence of an output schema, the description fully explains inputs, outputs, and an example. It is complete for an agent to correctly invoke the tool and understand its results.

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 100%, so the baseline is 3. The description rephrases parameters and adds an example with typical values, providing slight additional value over the schema. It does not introduce entirely new semantics.

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 it computes I2C pull-up resistor range, SCL timing budget, and STM32 TIMINGR register estimate. The verb 'Compute' and specific resources ('Rp min/max', 'SCL high/low', 'TIMINGR') make the purpose unambiguous. Among sibling calculators, this is distinct as the only I2C timing tool.

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 provides an example, lists arguments, and notes that the TIMINGR value is an estimate requiring production verification. However, it does not explicitly state when not to use this tool or compare to other calculators, which is acceptable for a specialized calculator.

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