Skip to main content
Glama

Get a product's onboarding flow

get_flow
Read-only

Get the complete onboarding flow for a product: every step in order with titles, notes on what happens, observed transitions (button labels and where they lead), and which steps are alternate branches. Includes the handoff reference id to use with buildHandoff.

Use this to study how a competitor structures their signup and onboarding, what information they collect at each step, and how they guide users to activation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
productIdYesProduct id from listProducts, e.g. linear, stripe or airbnb.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
stepsNo
capturedNo
flowTypeNo
flowTitleNo
handoffIdNoUse with buildHandoff to get the full prompt.
productIdNo
productNameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description usefully adds that branch steps are marked as alternates and that the response carries a handoff reference id consumed by buildHandoff — context an agent could not infer from annotations. It does not say what happens for an unknown productId, so it falls short of a 5.

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?

Two short paragraphs, front-loaded with what is returned, followed by the motivating use case; every sentence earns its place. There is mild overlap between the enumerated return fields and the existing output schema, which keeps it from a 5.

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?

Return values are covered by the output schema and safety by annotations, so the description only needs to sell the tool's purpose and linkage — which it does, including the buildHandoff handoff id. The one remaining gap is failure behavior for a bad productId, which matters given how the sibling listProducts is the intended id source.

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% and the single productId parameter already carries a description plus concrete examples (linear, stripe, airbnb) pointing at listProducts. The description adds nothing about the parameter, so the baseline 3 for a fully-covered schema is appropriate.

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 ('Get the complete onboarding flow for a product') and enumerates the payload at a level an agent can act on: ordered steps, titles, notes, observed transitions with button labels and destinations, alternate branches. This clearly distinguishes it from the sibling list_flows (enumeration) and get_screen (single screen), without the agent needing to open a 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?

Explicitly frames the use case: 'Use this to study how a competitor structures their signup and onboarding, what information they collect at each step, and how they guide users to activation.' It also names the downstream tool ('the handoff reference id to use with buildHandoff'), which is an actionable routing hint. It stops short of stating when NOT to use it or naming the sibling to prefer for lighter-weight lookups (e.g. list_flows).

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