Skip to main content
Glama

read_change_file

Read-only

Reads an exact UTF-16 slice of a selected change file for revision-aware review, with offset paging and revision checks for unchanged results.

Instructions

Exact UTF-16 text slice of a selected change file, including metadata or verification logs. Follow nextOffset with expectedRevision; knownRevision returns unchanged. Binary/oversized files require repository file tools.

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

Input Schema

NameRequiredDescriptionDefault
idYes
pathYes
limitNo
offsetNo
knownRevisionNo
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.
expectedRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A3.6/5.0
Behavior4/5

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

The annotations already mark this as read-only and closed-world, and the description adds useful behavior beyond that: UTF-16 text slicing, pagination via nextOffset, conditional revision behavior, and the binary/oversized limitation. It still does not describe error cases or the full return shape.

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?

The description is short and front-loaded, with no wasted sentences. It is dense but mostly efficient, though terms like nextOffset are used without clarifying that it is an output-side continuation value.

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

Completeness3/5

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

For a 7-parameter read tool with low schema description coverage and no output schema, the description covers the core slicing behavior and revision semantics but leaves several parameters underspecified. It is adequate but not complete enough for an agent to fully understand every input and return behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 14%, so the description needs to carry more parameter meaning. It explains knownRevision and expectedRevision behavior, but leaves id, path, limit, and offset mostly undocumented beyond the bare schema names.

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?

The description states a specific verb and resource: an exact UTF-16 text slice of a selected change file, including metadata or verification logs. It also points to repository file tools for binary/oversized files, though it does not explicitly distinguish this from the sibling read_change tool.

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?

It gives concrete usage guidance: follow nextOffset with expectedRevision, and knownRevision returns unchanged. It also names an alternative path for binary/oversized files via repository file tools, but does not explain when to prefer this over read_change.

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