get_i2c2_clockspeed_khz

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

No annotations provided. Description discloses unit, type, default, and requirement, but lacks details on behavior when requirement is not met or any side effects.

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 concise sentence with additional useful note. No extraneous 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?

Fairly complete for a simple getter with no parameters; includes default and requirement. Could mention that it's a read-only parameter and that a setter exists (set_i2c2_clockspeed_khz) but not necessary.

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?

Zero parameters; baseline 4. Description adds value by stating default value and requirement beyond the empty 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?

Clearly states it gets the I2C bus 2 clock speed in kHz. Distinguishes from siblings like get_i2c1_clockspeed_khz by specifying bus 2.

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?

Mentions a requirement (USE_I2C_DEVICE_2) which implies when the tool is available, but does not explicitly state when not to use or mention alternatives.

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