Skip to main content
Glama

Read a file

repo_file_read
Read-onlyIdempotent

Reads raw file text from a CNB.cool repository at a given branch, tag, or commit, enabling inspection of code or configuration at a specific version.

Instructions

Read the raw text content of a file at a given ref (branch/tag/commit).

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": {
      "repo": "<repo>",
      "ref": "<ref>",
      "path": "<path>"
    },
    "name": "repo_file_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
refYesBranch, tag or commit SHA
pathYesFile path inside the repository, e.g. src/index.ts
repoYesRepository path, e.g. "owner/repo" or "group/subgroup/repo"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds that content is returned as 'raw text', implying no parsing and likely no binary support, but says nothing about size limits, truncation, or error behavior for missing paths.

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?

A single front-loaded sentence with no filler; the operation, the return type and the ref concept all appear immediately. Nothing could be removed without losing information.

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 simple three-parameter read with no output schema and full annotation coverage, the definition is nearly adequate. Gaps remain around what happens with binary files, very large files, or non-existent paths, which matter for a raw-content read tool.

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 all three parameters (repo, ref, path) are already documented in the schema with examples. The description's mention of 'branch/tag/commit' for ref repeats the schema's own wording and adds no new semantics, so baseline 3 applies.

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 gives a specific verb ('Read') and resource ('raw text content of a file') plus the ref dimension, which distinguishes it from listing tools like repo_tree_list or metadata tools like repo_get. It does not explicitly name a sibling or contrast itself, so it falls short of 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 Guidelines3/5

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

Usage is implied: read one file's contents given repo, ref and path. There is no explicit guidance such as 'use repo_tree_list to discover paths first' or 'use repo_search to find a file by name', and no exclusions for binary or large files.

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