Skip to main content
Glama

get_flow

Read-only

Read a captured flow's headers, timing, capture counts and errors by flow_id without body I/O. Redacts sensitive headers and query fields for safe API analysis.

Instructions

Read headers, timing, capture counts and errors without body I/O. Requires flow_id. Optional observation_id enforces scope. Known sensitive headers and query fields are redacted.

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": {
      "flow_id": "<flow_id>"
    },
    "name": "get_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
flow_idYes
observation_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations, the description adds useful behavior: no body I/O, observation_id-based scoping, and redaction of known sensitive headers and query fields. It does not describe failure behavior or response structure, but it covers the most important non-obvious traits for this read-only tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core read behavior and follows with requirement, scoping, and redaction notes. Every sentence adds concrete information with no redundancy or filler.

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?

For a simple two-parameter read tool with no output schema, the description is largely complete: it covers purpose, required/optional parameters, privacy behavior, and the absence of body I/O. It could be stronger by clarifying return structure or error behavior, but nothing critical for invocation is missing.

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 0%, so the description must carry parameter meaning. It states that flow_id is required and that observation_id optionally enforces scope, which adds useful semantics, but it leaves ID formats and the exact meaning of scope unspecified.

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 states a specific read operation and enumerates the returned metadata: headers, timing, capture counts, and errors. The phrase 'without body I/O' clearly distinguishes it from body-reading siblings such as read_body, so an agent can identify its role without opening the 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?

It gives clear context for when to use the tool: reading flow metadata without body I/O, and it states that flow_id is required. However, it does not explicitly name alternatives like read_body or search_flows, nor does it explain how to obtain a flow_id.

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