GitHub repository readme
github_readmeFetches 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
| Name | Required | Description | Default |
|---|---|---|---|
| repo | Yes | Repository in owner/name form | |
| fresh | No | Bypass the local cache |