Skip to main content
Glama

ap_test_flow

ap_test_flow
Destructive

Test a flow end-to-end in the test environment. Requires a configured trigger. Waits up to 120s. Pass triggerTestData to provide mock trigger output when no sample data exists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
flowIdYesThe ID of the flow to test. Use ap_list_flows to find it.
displayNameNoShort approval prompt shown to the user (e.g. "Test Send Welcome Email"). Must include what the action does and the target name.
triggerTestDataNoMock trigger output data. Saved as sample data before running the test. Useful when the trigger has no prior test data.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and openWorldHint=true, and the description adds genuinely new behavioral facts beyond them: the test scope, the 120s wait ceiling, and that triggerTestData is persisted as sample data. It does not explain what the destructive aspect touches (e.g., flow state, published version), which is the main remaining gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the core purpose and then the prerequisite and timing bound. No filler or restatement of the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutating, non-idempotent test tool with no output schema, the description omits what a test result looks like (pass/fail, run ID to follow up with ap_get_run) and what state changes persist. It covers prerequisites and the mock-data path adequately, but the return/aftermath story is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so flowId, displayName, and triggerTestData are already documented. The description reinforces when to supply triggerTestData (no sample data), which is a mild addition, but adds nothing about displayName or the flowId lookup beyond the schema's own pointer to ap_list_flows. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Test a flow') and adds a scoping qualifier ('end-to-end in the test environment') that implicitly separates it from ap_test_step and ap_validate_flow. An agent can tell what this does without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a real prerequisite ('Requires a configured trigger'), a bound on behavior ('Waits up to 120s'), and a conditional instruction for triggerTestData when no sample data exists. It does not name an alternative tool or state when not to use it, so it falls short of the top tier.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources