Skip to main content
Glama

code.read

Read one file from the project repo. Text comes back as utf8; binary files as base64.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refNoBranch or commit, default main
pathYes
projectYesProject name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/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 behavioral burden. It usefully discloses that text is returned as utf8 and binary files as base64, but it omits auth requirements, error behavior for missing files, and explicit confirmation that the operation is non-mutating.

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 description is two short, front-loaded sentences with no wasted words. The core purpose is stated first, followed by the important return-encoding detail.

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 operation with no output schema, the description explains the return encoding and file scope. The main remaining gap is the undocumented path parameter and absence of error/auth context, but these are minor for this 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 67%, with project and ref documented in the schema and path undocumented. The description adds context that the file belongs to a project repo, but it does not add path syntax or clarify the project/ref/path roles beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/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: 'Read one file from the project repo.' It also clarifies scope ('one file') and distinguishes the operation from siblings like code.list and code.write.

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?

The phrase 'Read one file from the project repo' implies when the tool is appropriate, but it does not explicitly state when to use it instead of code.list or code.write. No exclusions or alternative-routing guidance are provided.

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