ftdi_i2c_transfer

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

With no annotations at all, the description carries the full behavioral burden, and it does disclose useful traits: the write-only mode via read_length=0, the clock-speed knob, and default FTDI URL. It does not describe failure behavior (NACK, missing bridge, wrong address) or whether a combined write_hex+read_length call performs a repeated-start write-then-read, which is the key operational ambiguity for an I2C transfer.

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 purpose is front-loaded in one sentence, followed by a scannable Args block with no filler. The Args list duplicates schema field names on purpose (needed given 0% schema coverage), so it earns its space, though it could be tightened.

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?

An output schema exists, so return values need not be described, and the parameter surface is well covered. However, for a hardware-touching I2C transfer tool with zero annotations, the definition omits the transfer semantics (combined write-then-read) and any expected failure modes, leaving the agent to guess on non-trivial invocations.

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 0%, so the description must compensate, and it largely does: every one of the six parameters is explained with format hints (7-bit address, 8-bit register, hex byte string '01 FF', default URL and frequency). The remaining gap is the interaction between register_addr, write_hex, and read_length — the description lists them but does not spell out the sequencing when all three are supplied.

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 first sentence names a specific verb pair (read and/or write), the resource (registers on an I2C slave device), and the transport path (FT232H/FTDI bridge). It is clearly distinguishable from ftdi_spi_transfer, but it never names ftdi_i2c_scan, so the agent must infer that scanning is a separate 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?

Usage is only implied: 'read and/or write' plus 'read_length: 0 for write-only' tells the agent how to configure a read vs. a write, but there is no statement of when to prefer this tool over ftdi_i2c_scan or when a transfer is inappropriate. No prerequisites (device present on bus, FTDI driver, permissions) are mentioned.

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