Skip to main content
Glama

Get Retained Result

result_get
Read-only

Retrieve and page through a budget-trimmed result using its retained ID; select a dotted path and slice arrays with offset/limit.

Instructions

Page through a result the response budget trimmed. Pass the retained.id from that response; path selects a field (dotted, e.g. files.0), offset/limit slice an array. Snapshot of the original call, kept for retained.expiresInSec.

Input Schema

NameRequiredDescriptionDefault
idNoRequired. retained.id from a trimmed response
pathNoDotted path into the payload; omit for the whole payload
limitNoDefault 100
offsetNoDefault 0

Output Schema

NameRequiredDescriptionDefault
idYes
pathYes
toolYes
totalNo
valueNo
offsetYes
retainedNo
capturedAtYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv5.0.1

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description usefully adds that this is a snapshot of the original call and that retention is time-limited via retained.expiresInSec, but says nothing about pagination boundaries, what an expired/missing id returns, or how partial slices behave when path is wrong.

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?

Three tight sentences, front-loaded with the core action, then the input source, then per-parameter meaning, then the retention caveat. Every clause carries information; nothing is repeated from 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?

An output schema exists, so return values need not be described, and the description covers the inputs, the id source, and the expiry mechanism. It stops short of the error/expiry path, which is the one gap for an agent recovering budget-trimmed data.

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 baseline is 3. The description earns above baseline by explaining path is dotted (example files.0) and that offset/limit slice an array, which is meaningful operational context the schema's terse 'Default 100'/'Default 0' strings do not convey.

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?

States a specific verb (page through) and resource (a result trimmed by the response budget), and pins down the entry point (retained.id from that response). An agent immediately understands this is the recovery mechanism for truncated payloads, a role no sibling competes for.

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?

Clearly says to pass retained.id from the trimmed response and explains that the snapshot is only kept for retained.expiresInSec. It gives clear context but never states what to do if the id has expired or what happens without an id, so no explicit exclusions.

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