set_i2c1_pullup

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

With no annotations provided, the description only states that it enables pull-up resistors. It does not disclose side effects, persistence across reboots, or other behavioral traits beyond the basic action.

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 concise—a single sentence with a parenthetical note—and front-loads the action. It contains no superfluous 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 one-parameter tool, the description is reasonably complete: it states the purpose, a prerequisite, and the parameter type. However, it lacks explicit explanation of valid parameter values (e.g., range or options) which would help an agent use the tool correctly.

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 input schema already describes the 'value' parameter. The description adds the data type ('UINT8') and default value ('OFF'), which provides additional context, though the schema's type is 'string'. The added default is useful but does not specify allowed numeric values.

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 action ('Set'), the resource ('i2c1_pullup'), and the effect ('Enable internal pull-up resistors on I2C bus 1'). It distinguishes from sibling tools like set_i2c2_pullup by specifying the exact bus. However, it does not explicitly compare with other similar tools.

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 mentions a prerequisite ('Requires: USE_I2C_DEVICE_1') indicating when compilation requires this feature, but provides no guidance on when to use this tool versus alternatives (e.g., when not to set pullups, or alternative configuration methods).

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