Connect MQTT IoT bus

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

Annotations indicate this is a write operation (readOnlyHint false) and modifies the world (openWorldHint true). The description's 'Create' is consistent with this. It adds context about the scaffold's purpose but does not disclose any side effects like whether it actually connects to a broker or just creates structure.

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 a single sentence with no filler. It is front-loaded with the action, making it easy to scan.

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 tool with 9 parameters and no output schema, a one-sentence description is insufficient. It lacks details on prerequisites, behavior, and any return values, making it hard for an agent to know what to expect.

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 only 44%, and the description itself does not mention any parameter specifics. It does not explain the meaning of qos, active, client_id, broker_port, or topic_count, leaving gaps for the agent.

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 a specific action ('Create an MQTT Client DAT bus scaffold') and specifies the purpose (IoT sensors, installation telemetry, policy-gated operator commands). This distinguishes it from other connection tools like WebSocket or serial bus 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 implies the tool is for MQTT-based IoT connectivity, but it does not explicitly state when to use it over alternatives such as other bus/connection tools. No exclusions or comparisons are provided.

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