Test Flow (Flow Designer)

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

The description discloses key behavioral traits beyond the annotations: it runs the flow in its current saved (draft) state and uses the ProcessFlow REST API endpoint. It also notes that a context ID is returned for polling. While the destructiveHint annotation warns of possible side effects, the description doesn't explicitly elaborate on potential data modifications, but the draft-state emphasis and API detail add meaningful context.

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 a bit long but every sentence contributes: it states the core function, primary use case, comparison with execute_flow, API details, parameter guidance, and next steps. The logical flow is clear, and no filler is present. It could be slightly tightened, but it is well-structured and front-loaded with the most important information.

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 complexity (testing flows), the description covers all essential aspects: what it does, when to use it, how to invoke it with parameter examples, what it returns (context ID), and what to do next. There is no output schema, but the description explicitly guides follow-up polling and retrieval, making it complete for an agent to use 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?

Although the schema descriptions cover 100% of parameters, the tool description adds extra meaning by explaining output_map with a concrete example for record-triggered flows and detailing flow_id formats. It also hints at the scope auto-resolution behavior, which supplements the schema's brief description. This goes beyond simply restating parameter names.

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's purpose: 'Test a ServiceNow Flow Designer flow without requiring it to be published.' It uses a specific verb ('test'), names the resource ('Flow Designer flow'), and distinguishes itself from execute_flow by noting it works on unpublished drafts. This is a strong, specific statement.

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?

The description explicitly positions test_flow as 'the PRIMARY tool to use when building and iterating on a flow' and contrasts it with execute_flow, which requires a published flow. It also recommends follow-up tools (get_flow_context_status, get_flow_outputs, get_flow_error) and provides example input for record-triggered flows, giving clear when-to-use and how-to-proceed guidance.

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