GX Device Info

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

The description adds valuable behavioral context beyond the annotations: it discloses that MAC address and hostname are not available via Modbus TCP, and specifies that Unit ID is always 100. 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, extremely concise, front-loaded with the core function and key exclusions. Every sentence adds value with zero waste.

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?

Given the tool's simplicity, the presence of output schema, and thorough parameter descriptions, the description is complete. It covers all essential constraints (unavailable fields, fixed Unit ID) for an agent to 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?

Schema description coverage is 100%, so the description doesn't need to redundantly explain parameters. However, it adds value by noting that MQTT defaults use environment variables and that portalId can be discovered via victron_mqtt_discover, which goes beyond the 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?

The description clearly states it retrieves GX device identity and connection info, listing specific included fields (serial number, relay states, system time, connection details) and explicitly excluding MAC address and hostname via Modbus TCP, which distinguishes it from other tools like 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?

It provides explicit guidance on what data is available and what is not, including a note that Unit ID is always 100. This helps the agent decide when to use this tool versus alternatives, such as using victron_network_scan for MAC/hostname.

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