get_user_flow
Get one user flow with its ordered steps, each including full screen metadata and image_url. Returns an error dict if the flow is not found.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Get one user flow with its ordered steps, each including full screen metadata and image_url. Returns an error dict if the flow is not found.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=false), so the description's added value is in disclosing the not-found behavior ('Returns an error dict if the flow is not found') and the result shape (ordered steps with screen metadata and image_url). That is genuinely useful disclosure beyond the annotations, though it says nothing about missing/incomplete flows or step ordering guarantees.
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?
Two tight sentences, front-loaded with what is returned and followed by the error case. No filler, no repetition of the tool name.
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 usefully summarizes the returned structure and the error case, and the read-only annotations cover safety. The remaining gaps are the undocumented slug argument and the absent pointer to list_user_flows as the way to discover valid slugs.
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 description coverage is 0% and the single parameter 'slug' has no schema description, so the description must compensate — but it never explains what 'slug' identifies, its format, or where to obtain it. Because there is only one param the burden is modest, but the gap is real.
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?
States a specific verb and resource ('Get one user flow') and even enumerates the payload (ordered steps, screen metadata, image_url), so the agent knows exactly what it returns. It does not explicitly contrast itself with the sibling list_user_flows, so the singular-vs-list distinction must be inferred from the names.
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?
No guidance on when to call this versus list_user_flows, and no indication of where the required slug comes from (presumably a prior list call). Usage is only implied by the name and the 'one' quantifier.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.