Skip to main content
Glama

Get user flow

get_flow
Read-onlyIdempotent

Read one user flow with observed outcomes, inferred expectations and scoped evidence.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "product": "<product>",
      "version": "<version>",
      "flowId": "<flowId>"
    },
    "name": "get_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
flowIdYesExact flow ID returned by list_flows.
productYesProduct key, for example finance-ozon-ru
versionYesExact capture version returned by list_versions. Pin the same version across related calls; do not use latest as an alias.
environmentNoEnvironment ID from the selected backend platform type in list_platforms.options.platforms[].environments[].id (backend implementation). Omit only when the version has one captured environment. Use captured pairs from list_platforms/list_versions for actual availability.

Output Schema

NameRequiredDescriptionDefault
flowNo
gapsYes
guidanceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is fully covered. The description adds a small amount of value by characterizing the payload as a mix of observed outcomes versus inferred expectations, which flags that some returned data is model-inferred rather than captured. It does not mention permission needs, size limits, or failure modes for a missing flowId, so it does not go far beyond the annotations.

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?

A single front-loaded sentence with the verb and resource first and zero filler. It is appropriately short, though the terseness is part of why usage guidance is absent.

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?

With an output schema present and full parameter documentation, the description need not explain return values or argument formats, and the annotations cover safety. The remaining gap is workflow context: for a detail-fetch tool gated on a flowId from list_flows, one clause on the list-then-get sequence would make it complete.

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

Parameters4/5

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

Schema coverage is 100% and each parameter carries substantive documentation, including the version-pinning rule ('do not use latest as an alias') and the environment omission rule. The description adds nothing parameter-level, so the baseline of 3 would apply, but the structured fields are unusually strong here rather than merely adequate.

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?

Clear specific verb plus resource plus scope: 'Read one user flow', which distinguishes it from the family of list_* siblings such as list_flows and list_replays. It also names the payload contents (observed outcomes, inferred expectations, scoped evidence), so an agent knows it is the detail-fetch counterpart to the list tool. It stops short of explicitly naming list_flows as the source of the ID, which is what would separate it from a 5.

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

Usage Guidelines2/5

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

The description gives no when-to-use, when-not-to-use, or alternative routing guidance. The only workflow hint ('Exact flow ID returned by list_flows') lives in the parameter schema, not the description, and nothing tells the agent how get_flow differs from sibling detail tools like get_scenario_manifest or get_page_summary.

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