Skip to main content
Glama

read_flow

Read-onlyIdempotent

Read full flow configuration, structure summary, entity lists, quota counts, or simulate a respondent path.

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": {
      "survey_id": "<survey_id>"
    },
    "name": "read_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
viewNoWhat to return (default: full flow config)
entity_idNoRead one entity when entity_kind is set
survey_idYesSurvey UUID
entity_kindNoList or read one entity of this kind
preview_condition_picksNoOnly with view "preview": condition set UUID → the condition (arm) UUID to simulate, both from read_flow entity_kind condition_set. A branch on a set left out follows its first arm.
preview_simulated_answersNoOnly with view "preview": question UUID → simulated answer, used to evaluate Skip Rules. Use the option value for a choice question; separate several picks with |.
preview_simulated_variablesNoOnly with view "preview": flow variable UUID (read_flow entity_kind variable) → simulated value, used to evaluate Skip Rules that test variables.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that one mode simulates a respondent path, which is meaningful behavior beyond the annotations, but it does not clarify that simulation has no side effects or how defaults are applied.

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 no filler, and the primary modes are listed up front. It is slightly list-like but every clause maps to a real capability.

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?

With an output schema present and full parameter coverage, the description need not explain return values or parameter formats. It adequately signals the multi-mode nature of a 7-parameter tool, though it could note the default view and the entity_kind/entity_id pairing more explicitly.

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 the schema already documents view, entity_kind, entity_id, and the three preview_* objects in detail. The description only echoes the view modes and adds no syntax or format meaning beyond the schema, so the baseline 3 applies.

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?

States a specific verb (read) and resource (flow) and enumerates the distinct modes: full config, structure summary, entity lists, quota counts, and path simulation. This lets an agent distinguish it from edit_flow and delete_flow_entity, though it does not explicitly contrast with read_block or read_question.

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

Usage Guidelines3/5

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

The enumerated modes imply when each is useful, but there is no explicit when-to-use/when-not guidance or named alternative for overlapping reads. The agent must infer that preview is for simulation and full is the default from the schema, not the description.

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