Skip to main content
Glama

read

Read-only

Retrieves UTF-8 text with line numbers using offset and limit controls, and must be used before modifying an existing file.

Instructions

Read UTF-8 text with line numbers. offset is zero-based; limit defaults to 2000. Required before modifying an existing file.

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": {
      "path": "<path>"
    },
    "name": "read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
limitNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare this as a read-only open-world operation. The description adds useful behavioral context: UTF-8 text, line-numbered output, zero-based offset, default limit of 2000, and the prerequisite for edits.

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 short sentences, front-loaded with the core action and immediately followed by pagination semantics and the editing prerequisite. There is no wasted text.

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 read tool with annotations and no output schema, the description covers the essential return shape and pagination defaults. It omits some edge-case details such as max limit behavior, but an agent can invoke it correctly from this definition.

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 parameter meaning. It explains offset is zero-based and limit defaults to 2000; path is self-evidently the file to read, though the limit maximum and exact truncation behavior are left to the schema.

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?

States a specific operation and output shape: reads UTF-8 text with line numbers. This distinguishes it from mutation siblings like write/edit, though it does not explicitly name alternatives such as grep or glob.

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?

Gives a clear usage condition: it is required before modifying an existing file. It does not state when not to use it or route the agent to search-oriented siblings, so it falls short of full when/when-not guidance.

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