get_i2c1_clockspeed_khz

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

No annotations provided, but the description adds value by disclosing the return type (UINT16), default value (800), and required feature. This is sufficient for a simple getter with no 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?

Extremely concise single sentence with key details (type, default, requirement). No extraneous information, all sentences earn their place.

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 parameterless getter, the description covers purpose, return type, default, and prerequisite. No output schema needed. Complete and self-contained.

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?

No parameters exist, so baseline is 4. The description adds context about the returned value's type and default, which is helpful despite the schema having 100% 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 clearly states the tool gets the I2C bus 1 clock speed in kHz, specifying the exact resource and distinguishing it from siblings like get_i2c2_clockspeed_khz. The requirement note adds specificity.

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?

Describes when to use via the required feature flag (USE_I2C_DEVICE_1). Contextually clear but does not explicitly mention when not to use or list alternatives beyond the naming pattern.

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