get_master_dtm_dataset

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

Without annotations, the description carries the burden and does well by detailing the internal XML structure (SlaveDevice, ModbusTCP, ManagedModbusRequest). It implies a read-only operation via 'Read'. However, it does not disclose prerequisites (e.g., project must be open) or error conditions.

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, with the first clearly stating the purpose. The second sentence is dense but informative, covering key XML elements. Could be slightly more concise, but overall efficient.

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 no output schema, the description adequately explains the return structure (XML elements and attributes like SlaveDevice, ManagedModbusRequest). Missing details on output format (string vs. object) and error handling, but sufficient for a read tool.

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 single parameter 'dtm' has no schema description, but the description adds meaning: 'dtm defaults to the first (CPU) DTM node'. This tells the agent what the parameter represents and its default behavior, which is valuable beyond the bare 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 the tool reads the master/CPU DTM dataset XML and specifies its content (Modbus TCP scan lines). It mentions the 'first (CPU) DTM node' default, but does not explicitly differentiate from sibling 'get_dtm_dataset', though the naming implies a distinction.

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?

No explicit guidance on when to use this tool versus alternatives like 'get_dtm_dataset' or 'set_master_dtm_dataset'. The description only hints at usage via the 'dtm' parameter default, but lacks when-to-use or when-not-to-use instructions.

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