Skip to main content
Glama

Read the product's repo

repo_read
Read-only

Through the Shipfound GitHub App, when the founder connected GitHub for this product (Settings): with no path, every file and folder of the repo on its default branch; with a folder, everything under it; with a file, its text (up to 300 KB). Never env files, keys or other secrets. For an agent without the code (ChatGPT, Claude); in Claude Code or Codex read the local repo instead. Free.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "repo_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoA file or folder in the repo, like src/app/page.tsx or docs. Leave out for the whole tree.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnly/openWorld/non-destructive, and the description adds substantial context on top: the 300 KB per-file cap, a hard guarantee that env files, keys and other secrets are never returned, the default-branch scope, the GitHub App prerequisite, and that the call is free. These are exactly the operational and auth details annotations cannot convey.

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?

Every sentence carries load — scope, limits, security, prerequisite, alternative, cost — with no filler. The opening clause ('Through the Shipfound GitHub App, when the founder connected GitHub for this product (Settings):') is a long run-on preamble that delays the core statement and costs it a point.

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

Completeness5/5

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

For a single-parameter, read-only tool with no output schema, the definition covers prerequisites, per-path behavior, size limits, security exclusions, and an alternative path for agents that have local code. An agent has everything needed to decide and call correctly.

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 coverage is 100% and the schema already explains the path format, so the baseline is 3. The description goes further by defining the semantics of each path shape (omitted = whole tree, folder = recursive contents, file = text capped at 300 KB), which meaningfully exceeds the schema's examples.

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 the repo's files/folders) and spells out exactly what each scope returns: no path = whole tree on default branch, folder = everything under it, file = its text. An agent can predict the output shape for each call without opening the schema.

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

Usage Guidelines5/5

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

It gives an explicit when-to-use ('for an agent without the code (ChatGPT, Claude)') and an explicit when-not ('in Claude Code or Codex read the local repo instead'), plus a prerequisite that GitHub must have been connected for this product in Settings. Nothing about selection is left to inference.

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