Skip to main content
Glama

ap_test_step

ap_test_step
Destructive

Test a single step within a flow. Runs all steps up to and including the specified step. The flow must have a configured trigger. Pass triggerTestData when no sample data exists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
flowIdYesThe ID of the flow containing the step. Use ap_list_flows to find it.
stepNameYesThe name of the step to test (e.g., "step_1"). Use ap_flow_structure to find it.
displayNameNoShort approval prompt shown to the user (e.g. "Test Send Email step in Welcome Flow"). 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

A3.9/5.0
Behavior4/5

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

Annotations already declare the mutation/destructive profile, and the description adds genuinely useful behavior: the test executes all prior steps, not just the target, which warns of cascading side effects, and it discloses that triggerTestData is persisted as sample data. Return format is not described, but no output schema exists so that is a minor gap.

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

Conciseness4/5

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

Three short sentences, each earning its place, with the core action front-loaded before the prerequisite and the conditional parameter hint. No filler or redundancy.

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

Completeness4/5

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

For a destructive mutation tool with full schema coverage and no output schema, the description covers the key things an agent needs: scope of execution, required trigger configuration, and when to supply test data. Only the success/failure response behavior is unaddressed.

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 coverage is 100%, so all four parameters, including their descriptions and the displayName approval-prompt requirement, are already documented. The description adds only the conditional note on triggerTestData, which is marginal beyond the schema's own 'Useful when the trigger has no prior test data' text, warranting the baseline 3.

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

Purpose4/5

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

The description states a specific verb and resource — testing a single step within a flow — and clarifies scope with 'runs all steps up to and including the specified step,' which distinguishes it from a whole-flow test. It does not explicitly name ap_test_flow as the alternative, so it falls short of full sibling differentiation.

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?

It gives a clear prerequisite ('The flow must have a configured trigger') and a conditional instruction ('Pass triggerTestData when no sample data exists'). It stops short of explicitly contrasting with ap_test_flow, so the agent must infer the alternative.

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