Skip to main content
Glama

read_body

Read-only

Reads bounded decoded request or response body text for a captured flow using offset and limit pagination, with known secret keys redacted. Use it to inspect API payloads on completed flows.

Instructions

Read bounded decoded text for flow_id and direction (request or response). offset and limit count Unicode code points after redaction; default 8000/max 32000. Decoder reads at most 1 MiB even for HTML. Known JSON/form secret keys redacted; arbitrary text is not guaranteed secret-free. Read completed flows for stable pagination.

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>",
      "direction": "<direction>"
    },
    "name": "read_body"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
flow_idYes
directionYes
observation_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

A4.1/5.0
Behavior5/5

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

Goes well past the annotations with details an agent could not otherwise know: the decoder reads at most 1 MiB even for HTML, offset/limit count Unicode code points after redaction, and known JSON/form secret keys are redacted while arbitrary text is not guaranteed secret-free. The pagination-stability note also explains why idempotentHint is false despite a readOnly operation.

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?

Five tight sentences, front-loaded with the core action and scope, then bounds, then safety caveats, then the pagination condition. No filler or repetition of the schema or annotations.

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 no output schema, the description still conveys that the return is bounded decoded text and documents truncation limits and redaction caveats, which covers most of what an agent needs. The unexplained observation_id parameter and the absence of any truncation/return-shape cue are the remaining gaps.

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 description coverage is 0%, so the description must carry the load, and it does for most parameters: offset/limit units (code points after redaction), default 8000 and max 32000, and direction as request or response. The fifth parameter, observation_id, is never mentioned, leaving one parameter's meaning undocumented anywhere.

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?

Specific verb+resource: 'Read bounded decoded text' scoped by flow_id and direction, which is inherently distinct from metadata-oriented siblings like get_flow. It never explicitly contrasts itself with an alternative, so sibling differentiation is implied by the resource rather than stated.

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 closing line 'Read completed flows for stable pagination' gives one real usage condition and implicitly warns against paginating in-progress flows. There is no explicit when-not guidance or named alternative (e.g., get_flow for headers/metadata), leaving selection partly to inference.

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