get_traceflow_result

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

Beyond annotations (readOnlyHint, etc.), the description details the return fields: operation_state (IN_PROGRESS/FINISHED/FAILED) and observations discriminated by resource_type, with specifics for Dropped* observations carrying reason and acl_rule_id. No contradiction.

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 concise and well-structured: a header '[READ]', a one-line summary, then detailed return information. Every sentence adds value without redundancy.

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 fully explains the return structure (operation_state and observations), including specifics for Dropped* observations. Complete for a read operation.

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?

With 0% schema coverage, the description explains both parameters: traceflow_id as the ID from run_traceflow, and target as optional NSX Manager target name. This adds significant context 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 'Get the current state and observations of an existing Traceflow.' Uses specific verb 'Get' and resource 'Traceflow', distinguishing it from sibling tools like 'run_traceflow' which initiates a traceflow.

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 says 'Use this to check a previously initiated traceflow without waiting.' Provides clear context but does not explicitly list when not to use it; however, the sibling list includes 'run_traceflow' as an alternative for initiating.

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