get_traceflow_result

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

The description adds substantial behavioral detail beyond the annotations (readOnlyHint, idempotentHint, destructiveHint). It discloses the returned operation_state values, typed observations, and special fields for Dropped types. It also explains the server-side lifecycle (completed traceflow is deleted and IDs 404), which is critical for handling errors.

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 appropriately sized: it front-loads the purpose with the [READ] tag and clear first sentence, then adds efficient detail about return values and lifecycle. The Args section is compact but also adds value. No filler, every sentence earns its place.

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?

With no output schema, the description compensates by explaining return values: operation_state, observations typed by resource_type, and Dropped* carrying reason/acl_rule_id. It also covers the edge case of 404s for completed traceflows, making the tool fully self-contained for an agent to invoke 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 coverage is 0%, so the description carries full weight. It explains traceflow_id as coming from a previous run_traceflow call, and target as an optional NSX Manager target from config. This adds real semantic meaning beyond the schema's bare string type definitions.

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 opens with "[READ] Get the current state and observations of an existing Traceflow," which uses a specific verb (Get), a clear resource (Traceflow), and scope (existing). It also distinguishes itself from the sibling run_traceflow tool by focusing on checking a previously initiated traceflow rather than starting one.

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 explicitly states when to use the tool: "Use this to check a previously initiated traceflow without waiting," providing clear context for post-run_traceflow polling. It also gives the important caveat that completed traceflows are deleted server-side and return 404. No explicit exclusion or alternative is named, but the guidance is unambiguous.

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