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

$ man github-readme

agentutility / web-probe / github-readme

PRICE / CALL

$0.005

USDC · base mainnet · scheme: exact

METHOD

POST

CLUSTER

webprobe

CATEGORY

uncategorized

STATUS

● live

NAME

github-readme — fetches the raw readme markdown for any public github repository via the official github rest api, no auth required for public repos

SYNOPSIS

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

     { ... }

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

DESCRIPTION

Fetches 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. Use it as a repo readme fetch, open-source-readme-as-markdown endpoint, or package documentation puller.

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.agentutility.ai/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 the MCP package for this endpoint's cluster
npx -y @agentutility/mcp-<cluster>

# Required: EVM private key with USDC on Base
export X402_PRIVATE_KEY=0x...

# Then call the github-readme tool from your MCP-aware agent.

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.005 USDC per call

ADJACENT — other endpoints in webprobe

endpoint	description	price
arxiv-bibtex	Turns an arXiv paper into a BibTeX entry: pulls title, authors, year, abstract, and DOI from the arXiv API and generates a properly-forma…	$0.005
brand-name-score	Scores a candidate brand or startup name on quality and risk.	$0.005
company-name-score	Scores the quality of a company name before you commit to domain, handle, trademark, and launch work.	$0.005
crypto-headlines	Searches recent bitcoin, ethereum, and DeFi headlines via GDELT with a GNews fallback when configured, returning headline URLs, domains,…	$0.005
crypto-news	Fetches recent cryptocurrency news headlines from GDELT with a GNews fallback when configured, filtered by crypto topic or caller query,…	$0.005
disposable-email-check	Detects disposable and throwaway email addresses before they get through your signup form.	$0.005
domain-availability	Checks whether a domain is registered and returns registrar, registration date, expiry date, days_until_expiry, and current EPP status flags.	$0.005
email	Validates an email address end to end: syntax, MX reachability, disposable/temp-mail domains, role accounts, and SPF/DMARC/DKIM posture.	$0.005