Get Package README
docs_get_readmeFetch the real README/description for a package, straight from the registry — not a summary, not a paraphrase, not AI-generated.
For npm this reads the registry's stored README, falling back to the published README.md file via jsDelivr if the registry copy is missing (verbatim markdown). For PyPI this reads the exact long_description shown on the package's PyPI page (verbatim). For Cargo (Rust/crates.io) this reads crates.io's stored README — note: crates.io only stores a pre-rendered HTML version, not the original markdown source, so this is that HTML converted to plain text, not byte-for-byte source.
Args:
ecosystem ('npm' | 'pypi' | 'cargo')
package_name (string): exact package name
version (string, optional): specific version; defaults to latest
Returns JSON with: readme (truncated to 12000 chars if longer — check 'truncated'), truncated (boolean), source_url (exact URL fetched, for verification), fetched_at.
Error Handling:
Returns "Error: ..." if the package or its README cannot be found — never fabricates content to fill the gap. [PAID: $0.009 per call via x402 - send a PAYMENT-SIGNATURE header on the /mcp request; unpaid calls return an HTTP 402 x402 challenge with five accepts at the same $0.009 price: Base USDC (9000 atomic), Solana USDC (9000 atomic), XRPL XRP (drops at the live XRP/USD rate), Arc USDC (9000 atomic), or Xahau XAH (drops at the live XAH/USD rate). The other ScriptDocs tools are free.]
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": {
"ecosystem": "<ecosystem>",
"package_name": "<package_name>"
},
"name": "docs_get_readme"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | Specific version to fetch. Defaults to the latest published version if omitted. | |
| ecosystem | Yes | Which package registry to query: 'npm', 'pypi', or 'cargo'. | |
| package_name | Yes | Exact package name as published on the registry. |