Skip to main content
Glama
github-fetcher

github-fetcher

by KurvCygnus

GitHub repository readme

github_readme
Read-onlyIdempotent

Fetches a repository's README via GitHub's readme endpoint, resolving default filename variants like README.md or README.zh-CN.md automatically. Use it to read project docs without knowing the exact README path.

Instructions

Fetch a repository's README through GitHub's readme endpoint, which resolves the default naming variant (README.md, README.zh-CN.md, and friends); use github_file for a specific path. Costs 1 core call. Returns {repo, path, sha, size, encoding, content, binary, truncated}.

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": {
      "repo": "<repo>"
    },
    "name": "github_readme"
  }
}

Input Schema

NameRequiredDescriptionDefault
repoYesRepository in owner/name form
freshNoBypass the local cache

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, open-world, non-destructive, so the safety profile is covered. The description adds genuinely useful context beyond that: the cost is 1 core call, the endpoint auto-resolves naming variants, and the returned keys are listed. It falls short of 5 because the local cache and the `fresh` bypass, plus what happens when `truncated` or `binary` is true, are never explained.

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 tight sentences: purpose and resolution behavior first, the sibling disambiguation second, cost and return shape last. No filler, and the most decision-relevant information is front-loaded.

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 two-parameter read tool with no output schema, it is nearly complete: it lists the return keys and states the call cost. Minor gaps remain around cache semantics for `fresh` and how truncated/binary responses should be handled, which matter for a content-fetching 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 coverage is 100%: `repo` is documented as owner/name and `fresh` as bypassing the local cache. The description adds nothing about either parameter, so the schema is doing all the work and the baseline of 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?

Names a specific verb and resource ("Fetch a repository's README") plus the mechanism (GitHub's readme endpoint) and the key behavior of resolving default naming variants. It explicitly distinguishes itself from github_file, so an agent can choose between them without reading either 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?

States the selecting condition directly: use this tool for the auto-resolved README, use github_file when you have a specific path. That is an explicit alternative plus the condition that picks it, which is exactly what routing guidance should do.

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