Skip to main content
Glama

SCRIPTMASTERLABS — ScriptDocs

Get Package README

docs_get_readme
Read-onlyIdempotent

Fetch 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 USDC per call via x402 on Base - send a PAYMENT-SIGNATURE header on the /mcp request; unpaid calls return an HTTP 402 x402 challenge (amount 9000 atomic USDC). The other ScriptDocs tools are free.]

Input Schema

NameRequiredDescriptionDefault
versionNoSpecific version to fetch. Defaults to the latest published version if omitted.
ecosystemYesWhich package registry to query: 'npm', 'pypi', or 'cargo'.
package_nameYesExact package name as published on the registry.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds substantial context beyond the annotations: npm registry-vs-jsDelivr fallback, PyPI long_description sourcing, Cargo pre-rendered HTML caveat, 12,000-character truncation, exact URL for verification, and a strong no-fabrication error policy. It also discloses the paid x402 $0.009 USDC requirement and the HTTP 402 challenge behavior, which is essential operational information an agent cannot get from the schema or annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and per-ecosystem behavior, then structured into Args, Returns, Error Handling, and payment notes. It is somewhat long and the Args section duplicates the schema, but no sentence is wasted and the payment disclosure is high-value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Although there is no output schema, the description documents the return JSON fields (readme, truncated, source_url, fetched_at) and explains truncation. It also covers error behavior and payment prerequisites, so an agent has everything needed to call this tool correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already fully documents ecosystem, package_name, and version. The description's Args section largely restates those fields and adds only the emphasis that package_name must be exact and version defaults to latest, both already present in the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Fetch the real README/description for a package, straight from the registry,' and explicitly rules out summaries or AI-generated content. It is clearly distinct from a generic search, but it never names which sibling (e.g., docs_get_package_info or docs_search_docs) to use instead for adjacent needs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The usage context is strongly implied — use this when you need verbatim README content — and per-ecosystem behavior is explained in detail. However, there is no explicit when-to-use versus when-not guidance against the sibling tools like docs_get_package_info or docs_search_docs, leaving the agent to infer routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources