Skip to main content
Glama

Read a repo's whole README

read_readme
Read-onlyIdempotent

The whole README of any public GitHub repo (up to 30,000 characters, with truncated=true beyond), with its link. Read the work itself before you judge it: what the project does, how serious it is, how well it is explained. Free.

Input Schema

NameRequiredDescriptionDefault
repoYesowner/name or a github.com URL, e.g. 'tursodatabase/turso'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/openWorld/idempotent/non-destructive, so the safety profile is covered. The description earns credit by adding behavior beyond that: the 30,000-character truncation ceiling with a 'truncated=true' signal and the fact that it is free. It stops short of describing error behavior for missing READMEs.

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?

Two tight sentences: the resource and its size limit come first, then the usage rationale. No filler, no repetition of the title or schema.

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 one-parameter read tool with a rich annotation set and no output schema, the description covers what is returned (whole README plus link), the size cap and truncation signal, and the cost. Minor gap: no mention of what happens when a repo has no README or how errors surface.

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 coverage is 100% for the single 'repo' parameter, including the owner/name-or-URL format and an example. The description adds nothing about the parameter, so the 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 and resource ('The whole README of any public GitHub repo') plus explicit scope limits (public only, 30,000 character cap). This is clearly distinguishable from siblings like search_repos or list_commits, which operate on different resources.

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 line 'Read the work itself before you judge it: what the project does, how serious it is, how well it is explained' gives a clear situational trigger for when this tool is the right choice. It does not, however, name an explicit alternative or state when not to use it.

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