add_dtm

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

No annotations provided, but description discloses creation behavior and hierarchy. Does not mention permissions or side effects, but covers what the tool does adequately for a non-destructive add operation.

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?

Concise with two paragraphs; front-loaded key action, then examples. No fluff, but could be slightly more compact.

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 annotations or output schema, description covers main use cases and parameter roles. Does not explain return values or error conditions, but acceptable for an add 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?

Schema coverage is 0%, description explains device_type_name (catalog entry) and parent_dtm (empty/name) well, but omits protocol_id, prog_id, version. Required params are covered, but not all six.

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 'Add a DTM to the project topology', specifies top-level vs slave, and distinguishes from sibling tools like delete_dtm and list_dtms.

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?

Explicitly explains when to use parent_dtm (empty for top-level, set for slave) and provides follow-up steps (set_dtm_address, etc.). Differentiates from other add tools targeting different resources.

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