Skip to main content
Glama

Read an object

read_object
Read-only

Reads a text object's content. Large or binary objects come back as a download URL instead. To sample a large text file, pass head or tail for whole lines from either end, or offset and length to read a byte window anywhere in it. maxBytes lowers the size of the answer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesFull object key.
headNoReturn only the first N lines.
tailNoReturn only the last N lines.
bucketYesBucket name.
lengthNoHow many bytes to read from offset; defaults to the answer's byte ceiling.
offsetNoByte to start reading at, 0-based. Not combinable with head or tail. The window is not line-aligned.
maxBytesNoCap the bytes this answer may carry. Only lowers the server's own ceiling, never raises it.
connectionIdYesConnection id from list_connections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the read-only, non-destructive safety profile, so the bar is lower. The description still adds genuine behavior: large or binary content is returned as a download URL rather than bytes, and maxBytes only lowers (never raises) the server ceiling. It omits error/permission behavior, but the added context is valuable.

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?

Front-loaded with the core purpose, then three tight sentences covering fallback behavior and sampling modes with no filler. Minor imprecision ('the answer' for the response) but every sentence earns its place.

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?

No output schema exists, yet the description explains the two possible return shapes (inline content vs download URL) and the sampling parameters, which is the critical return-value context for a read tool. Remaining gap is the absence of any sibling routing guidance.

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, but the description earns extra credit by framing head/tail as whole-line sampling from either end versus offset/length as a byte window, and clarifying maxBytes as a downward-only cap. This clarifies the interaction between parameters beyond the per-field schema text.

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: 'Reads a text object's content,' and it discloses the key behavioral distinction that large/binary objects return a download URL. It stops short of explicitly naming a sibling (e.g. get_object_metadata or create_download_link) to route the agent, so it is clear but not fully differentiated.

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?

It gives useful in-tool guidance on how to sample a large text file (head/tail vs offset/length), which is real usage context. However it never states when to choose read_object over siblings like get_object_metadata, create_download_link, or find_objects, so the when-to-use choice is left implicit.

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