Skip to main content
Glama

flow-read-prerequisite

Check a flow's required app or simulator state without executing it. Reads the prerequisite from the flow file so you can verify conditions before calling flow-execute.

Instructions

Read the execution prerequisite of a flow without running it — a saved flow from the .argent/flows/ directory, or an explicit boundary-managed flow_path. Returns the prerequisite description so you can verify the required state is met before calling flow-execute. Use when you need to check what app/simulator state is required before executing a flow; pass the same flow source (name or flow_path) you will pass to flow-execute, so the prerequisite you read is the contract of the flow that will actually run. Fails if the flow file does not exist.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoName of a saved flow to inspect from `.argent/flows` (e.g. "settings-explore"). Omit when flow_path is set.
flow_fileNoPath to the flow .yaml as readable by the tool-server. Internal — the argent client derives it from project_root and name automatically; leave unset.
flow_pathNoAbsolute path to a co-located flow .yaml on the client and tool server's shared filesystem. This must be supplied through the file-input boundary. Pass the same flow source here as to flow-execute, so the prerequisite you read belongs to the flow that will run; for remote reads, pass name + project_root instead.
project_rootYesAbsolute path to the calling agent's project root — the cwd it is working in. With name, the saved flow is read from `.argent/flows/<name>.yaml` under this root; with flow_path, the prerequisite is read from that YAML instead, so pass the agent's cwd.
Behavior4/5

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

With no annotations, the description correctly carries the burden of behavioral disclosure. It discloses that the operation does not execute the flow (read-only), returns a prerequisite description, and fails if the flow file does not exist. However, it does not detail the return format beyond 'description' or mention any auth/permission requirements, which might be relevant for a tool reading from the filesystem.

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?

The description is four sentences but each provides necessary context: the core function, return value, usage guidance, and failure condition. It is front-loaded with the verb+resource and does not include filler. Slightly longer than the minimal ideal but still efficient.

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?

Given the absence of an output schema, the description explains what is returned (a prerequisite description) and a key error condition. It also addresses the parameter relationship with flow-execute. However, it leaves some ambiguity around the 'boundary-managed flow_path' concept and does not elaborate on the structure of the returned prerequisite description. For a simple read tool with detailed schemas, this is close to 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%, so the baseline is 3. The description adds semantic value by explicitly connecting name/flow_path to the flow-execute invocation: 'pass the same flow source (name or flow_path) you will pass to flow-execute.' It also clarifies that flow_path is 'boundary-managed,' hinting at the file-input boundary distinction. This goes beyond the schema's per-parameter descriptions.

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?

The description opens with 'Read the execution prerequisite of a flow without running it,' clearly specifying the verb (read) and resource (execution prerequisite of a flow). It distinguishes from sibling flow-execute by explicitly stating it does not run the flow, and explains the two valid sources (saved flow or flow_path).

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?

The description explicitly states when to use it: 'Use when you need to check what app/simulator state is required before executing a flow.' It also gives a concrete recommendation to pass the same flow source as flow-execute to ensure the prerequisite read matches the flow that will run. It does not explicitly mention alternatives or when-not-to-use, but the 'without running it' contrast with flow-execute provides implicit exclusion.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/software-mansion/argent'

If you have feedback or need assistance with the MCP directory API, please join our Discord server