Skip to main content
Glama

Read file

read_file
Read-only

Read a UTF-8 text file from an artifact you own or have joined (any role can read) without changing its revision.

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_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description earns credit for adding substance beyond them: the file must be UTF-8 text, the read leaves the revision untouched, and any role suffices. It doesn't cover failure modes (missing path, binary file, size limits), which keeps it from a 5.

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 sentence, with the action and encoding constraint front-loaded and the access/scoping caveat trailing. No redundant restatement of the title and nothing that could be cut 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?

Adequate for a small read-only tool with annotations covering safety, but two gaps remain: with no output schema, the description never says what comes back (raw text? size limits? truncation?), and neither parameter is characterized. For a 2-required-param tool with 0% schema coverage, more would be expected.

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 0%, so the description carries the full burden for the two required parameters, and it largely doesn't meet it. 'id' and 'path' are never explained — the reader must infer that 'id' is the artifact and 'path' is the file within it, and nothing states path format (leading slash, nesting, encoding).

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 (Read) and resource (a UTF-8 text file), and scopes it to artifacts the caller owns or has joined. Combined with siblings like edit_file, write_files, and get_artifact, the scope constraint 'without changing its revision' makes the read-only content-fetch role reasonably distinct. It doesn't name an alternative tool, but the purpose is clear.

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 an explicit precondition: the artifact must be one you own or have joined, and notes 'any role can read,' which tells the agent that permission checks won't block the call. It stops short of naming alternatives (e.g. use get_artifact for metadata, edit_file to modify), so it's clear context without exclusions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources