{"uid":"cap_9F5xh1bNi24GUe48MBbgU","slug":"github-readme-fetcher-2f38929b","name":"GitHub README Fetcher","description":"README of a GitHub repository as plain text (markdown kept, up to 20k chars): tries the default branch and common README filenames, reports which file and branch matched, length, headings list, and the raw URL. Fast repo comprehension for coding agents. $0.01 per repo.","url":"https://intel.rallylive.ca/dev/github-readme","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET"],"type":"string"},"queryParams":{"type":"object","properties":{}}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object"}}}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.01","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.01/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_AOEIKsQ3ZGkEBnhHk3T_D","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.01","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Fetches the raw README text of any GitHub repository, returning the markdown content (up to 20k chars), matched filename, branch, headings list, content length, and raw URL.","exampleAgentPrompt":"Can you fetch the README from the GitHub repository at https://github.com/openai/openai-python and show me the headings and the full markdown text?","exampleUseCases":[{"title":"Understand an unfamiliar open source library","prompt":"Pull the README from https://github.com/huggingface/transformers and give me a summary of what the project does and what its main sections cover."},{"title":"Automated dependency documentation scan","prompt":"For each of these GitHub repos — https://github.com/psf/requests and https://github.com/encode/httpx — fetch the README and tell me what the installation instructions look like."},{"title":"Coding agent repo comprehension before contributing","prompt":"Before I start working on https://github.com/tiangolo/fastapi, can you grab its README and list all the headings so I know how the docs are structured?"}],"resultDescription":"Returns the repository's README as plain markdown text (up to 20,000 characters), along with the matched branch name, README filename (e.g. README.md), a list of headings extracted from the content, total character length, and the raw file URL on GitHub.","failureModes":["Repository not found or is private — returns an error indicating the repo could not be accessed","No recognized README file exists in the repository — returns an error with no match","Repository has a README but it exceeds 20k characters — content is truncated at 20,000 chars","Invalid or malformed repository URL provided — returns a validation error","GitHub rate limits or network issues — returns a timeout or upstream error"],"whenToPreferThis":"Use this endpoint when an agent needs fast, structured comprehension of a GitHub repository's README without cloning the repo or calling the GitHub API directly. Ideal for coding agents, documentation scanners, or dependency analyzers that need the project description, setup instructions, and documentation structure in a single lightweight call. Prefer this over generic web scrapers when the target is specifically a GitHub README, as it handles branch detection and common filename variants automatically.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-14T13:13:16.554Z","isFirstParty":false}