Name: github-readme
Price: 0.002 USDC
Availability: InStock

$ man github-readme

agentutility / web-probe / github-readme

PRICE / CALL

$0.002

USDC · base mainnet · scheme: exact

METHOD

POST

CLUSTER

webprobe

CATEGORY

uncategorized

STATUS

● live

NAME

github-readme — github readme fetch / repo readme / open-source-readme-as-markdown / package documentation puller

SYNOPSIS

POST https://x402.org/v1/github-readme
     Content-Type: application/json
     X-PAYMENT:    <signed-transferWithAuthorization>

     { ... }

↳ first call → 402 Payment Required. Sign USDCtransferWithAuthorization, retry with theX-PAYMENT header.

DESCRIPTION

GitHub README fetch / repo readme / open-source-readme-as-markdown / package documentation puller. Pulls the raw README markdown for any public GitHub repository via the official GitHub REST API — no auth required for public repos. Returns the unaltered markdown plus byte size and char count. Useful for agents documenting a stack, explaining a library, or snipping an example.

INPUT — request schema

property	type	description	req?
repo	string	Repository in 'owner/name' form (e.g. 'vercel/next.js').	required

OUTPUT — response shape

field	type	description
repo	string	Repository slug in owner/name form that was fetched, echoed back from the request input.
raw_markdown	string	Unaltered README markdown as returned by the GitHub REST API, with original headings, code fences, and links intact.
byte_size	string	Size of the raw markdown payload in bytes, useful for budgeting downstream context windows.
char_count	string	Total character count of the markdown string, including whitespace and newlines.
source	string	Upstream API the markdown came from, typically the GitHub REST contents endpoint URL for the repo's README.

EXAMPLES — two ways to call

EXAMPLE 1 · curl

curl -X POST https://x402.org/v1/github-readme \
  -H 'Content-Type: application/json' \
  -d '{ }'

first response = 402 Payment Required with payment requirements; sign + retry with X-PAYMENT.

EXAMPLE 2 · mcp

# install once
claude mcp add x402 --command "npx x402-deployer-mcp"

# then ask Claude Code:
# "use the github-readme tool to ..."

MCP server handles payment automatically — your coding agent just calls the tool by name.

METADATA

tags: web-probegithubreadmemarkdowndocumentationrepo-metadatagithub-readme
methods: POST
cluster: webprobe
price: $0.002 USDC per call

ADJACENT — other endpoints in webprobe

endpoint	description	price
arxiv-bibtex	arXiv to BibTeX / arxiv citation generator / paper bibtex / LaTeX citation builder / academic citation lookup.	$0.002
keyword-suggest	Keyword autocomplete / search suggest / SEO keyword research / query expansion / autocomplete suggestions.	$0.002
qr-code-decode	QR decoder / QR reader / scan QR from URL / QR code OCR / barcode reader / link extraction from QR.	$0.002
hacker-news-search	Hacker News search / HN search / yc-news / Algolia HN.	$0.001
hn-search	HN search / Hacker News search / yc-news / startup-news search / Algolia HN / who-is-hiring scraper / programmer-news firehose.	$0.001
homoglyph-check	Homoglyph attack detector / Unicode lookalike scanner.	$0.003
ip-asn	IP to ASN / IP geolocation / IP-to-ISP lookup / WHOIS for IP / cloud-provider attribution.	$0.001
jwt-decode	JWT decoder / token inspector / debug tool.	$0.003

/github-readme(1)