Skip to main content
Glama

Git Hub Read

github_read

Read a file, or list a directory, in a GitHub repository you connected. Give repo as owner/name, a path (empty for the root) and optionally a branch, tag or commit as ref. Text files up to 1 MB; binary files are refused.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refNoBranch, tag or commit; the default branch when omitted.
pathNoFile or directory path; empty for the repository root.
repoYesRepository as owner/name, e.g. merino-outdoor/shop-theme.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/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 burden. It does disclose real constraints — 1 MB text limit and that binary files are refused — which is valuable. But it omits auth/permission requirements, error behavior, and the shape of what a read or a directory listing returns, leaving meaningful behavioral gaps.

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?

Three sentences, zero filler, front-loaded with the core capability followed by call guidance and then the hard limits. Every sentence earns its place.

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 read tool with no output schema and no annotations, the description covers modes, argument formats and limits adequately. The main remaining gap is the return shape (file content vs. directory listing contents/metadata), which an agent must infer.

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 repo/path/ref semantics and examples are already documented in the schema. The description restates them ('owner/name', 'empty for the root', 'branch, tag or commit as ref') without adding new syntax or edge-case meaning, so baseline 3 applies.

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?

States a specific verb (read) and resource (file or directory inside a GitHub repository) plus the dual mode explicitly. This naturally separates it from github_search (search) and github_repos (enumerate repos), so an agent can route correctly without opening a schema.

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?

The two modes (read a file / list a directory) and the scoping constraint ('a GitHub repository you connected') give clear context for when the tool applies. It never names an alternative (github_search, github_repos) or states when not to use it, so exclusions are missing.

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