Skip to main content
Glama
agentic-search-mcp

agentic-search-mcp

read

Retrieve numbered lines from a text file, with optional zero-based offset and line limit, to inspect specific sections of a file.

Instructions

Read a text file and return numbered lines.

Args: path: File path, absolute or relative to the search root. offset: Zero-based line number to start from (default 0). limit: Maximum number of lines to return (default 2000).

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

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose that output is line-numbered and that offset/limit have defaults of 0 and 2000. It omits important behavior: whether truncation is signaled, what happens on a missing path, encoding handling, and whether binary files are rejected.

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?

The one-line summary is front-loaded, followed by a compact Args block with one entry per parameter. No sentence is redundant, and the structure is easy for an agent to parse.

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 three-parameter read tool with an output schema covering return values, the description supplies the essentials: purpose, pagination semantics, and defaults. It could add error and truncation behavior to be fully complete.

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 compensate, and it documents all three parameters, including the non-obvious detail that offset is zero-based and that limit defaults to 2000 lines. Only minor ambiguity remains, such as whether offset is applied before or after the returned line numbering.

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 verb and resource plus a return characteristic: 'Read a text file and return numbered lines.' This makes it distinguishable from glob (file discovery) and grep (content search) in practice. It stops short of explicitly naming those siblings as non-alternatives, so it lands just under a 5.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance is provided. Nothing tells the agent to prefer grep for pattern search or glob for discovery, and nothing warns about binary files or oversized files.

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

Deploy Server

Other Tools