Skip to main content
Glama

cat

Read-only

Read file contents with support for byte offsets, length limits, and encoding. Returns JSON or raw text for agent workflows.

Instructions

Read and output file contents. Read-only, no side effects. Returns JSON by default with bounded content; use --raw for full plain-text output. Supports byte-offset and length for partial reads. Use to inspect file contents in agent workflows. Not for binary inspection — use 'od' for hex/octal dumps. See also 'head', 'tail', 'od'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rawNoWrite raw bytes to stdout without a JSON envelope.
pathYesFile to read.
offsetNoByte offset to start reading from.
encodingNoText encoding (default: utf-8). Use 'auto' for BOM/autodetection.utf-8
max_bytesNoMaximum bytes to return.
show_encodingNoInclude encoding detection metadata in JSON result.
encoding_errorsNoHow to handle encoding errors (default: replace).replace
encoding_profileNoLocale-aware encoding fallback profile for auto-detection.
Behavior4/5

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

Annotations already declare readOnlyHint=true. Description adds 'Read-only, no side effects', details on output formats (JSON default vs raw), and bounded content. No contradictions.

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 efficient sentences, front-loaded with main purpose and key behaviors. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers output format, safety (read-only), partial reads, encoding, and alternatives. Enough for an agent to use correctly without output schema.

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 100%, so baseline is 3. Description adds context for --raw flag and byte-offset/length but does not elaborate on all 8 parameters. Schema already documents them adequately.

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?

Clearly states 'Read and output file contents' with specific verb and resource. Distinguishes from siblings by mentioning alternative tools (head, tail, od) and noting not for binary inspection.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use (inspect file contents in agent workflows) and when not to use (binary inspection -> use od). Provides alternative tool names.

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/caseSHY/AI-CLI'

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