get_i2c3_clockspeed_khz

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

No annotations provided, so description carries full burden. States it reads a value ('Get'), notes requirement 'USE_I2C_DEVICE_3', and specifies type/range. For a simple getter, this offers good behavioral context beyond the empty schema.

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 line with title, explanation, requirement, and default. No wasted words; every part 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?

Tool is simple with no params and no output schema. Description covers what is read, the requirement, and the type/default. Complete for a getter among many similar siblings.

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, so no param info needed. Description adds type hint and default value, which is useful but not about parameters. Baseline 4 for 0-param tool with 100% 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?

Clear verb 'Get' and specific resource 'i2c3_clockspeed_khz' with explicit unit 'kHz'. Distinguishes from siblings like get_i2c1_clockspeed_khz and get_i2c2_clockspeed_khz by specifying bus 3.

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?

Description implies use for reading I2C bus 3 clock speed, but no explicit guidance on when to use over alternative buses or related tools like get_i2c3_pullup. Context is clear but lacks decision support.

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