System Setup

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

Annotations (readOnlyHint, idempotentHint, destructiveHint) already indicate non-destructive read/idempotent operation. The description adds behavioral context: connectivity tests, discovery, transport recommendation, config generation. No contradictions with annotations.

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?

Two sentences, front-loaded with core purpose. No redundant information. Every word adds value, achieving high information density without verbosity.

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?

Complete for a setup tool with 3 parameters, output schema, and numerous siblings. Explains purpose, usage sequence, and output. References sibling tool (victron_network_scan) for context. No missing guidance for an AI agent.

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 coverage is 100%, so baseline 3. Description adds minimal extra meaning for parameters: mentions 'host IP' but otherwise relies on schema descriptions for port defaults. No significant enrichment beyond schema.

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?

Description uses specific verbs and resources: 'complete system setup and discovery', 'tests Modbus TCP and MQTT connectivity', 'discovers all connected devices and services', 'recommends the best transport', 'generates ready-to-use MCP server configuration'. It distinguishes from siblings by positioning itself as the first step after victron_network_scan.

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?

Explicit use case: 'Use this as the first step after finding a device with victron_network_scan, or directly if you already know the host IP.' Does not explicitly state when not to use or list alternatives, but the context and sibling list provide implicit guidance.

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