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 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

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?

Annotations already declare readOnly/idempotent/non-destructive, but the description adds substantially beyond them: per-ecosystem source resolution (registry copy, jsDelivr fallback, PyPI long_description), the cargo caveat that output is HTML-converted plain text rather than original markdown, 12000-char truncation with a 'truncated' flag, and honest failure ('Returns "Error: ..." — never fabricates content'). It also discloses the critical operational constraint that calls cost $0.009 via x402 and unpaid calls return HTTP 402 — the single most important thing an agent needs before invoking.

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?

Front-loaded with the core promise, then organized into clear sections (per-registry behavior, Args, Returns, Error Handling, payment). The Args block is redundant against a fully-described schema and the payment paragraph is dense, but both carry decision-relevant information rather than filler.

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?

With no output schema, the description still enumerates every returned field (readme, truncated, source_url, fetched_at) and explains the truncation boundary. Combined with per-ecosystem source caveats, failure semantics and the payment prerequisite, an agent has everything needed to call it correctly and interpret the result.

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 enum values, exact-name requirement and 'defaults to latest' semantics are already documented in structured form; the Args block largely restates them. No additional guidance is given on name normalization or version formats, so baseline 3 applies.

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 ('Fetch') and resource ('the real README/description for a package') and scopes it to the registry, plus explicit negatives ('not a summary, not a paraphrase, not AI-generated') that separate it from docs_search_docs-style tools. It never names a sibling directly, so the differentiation is inferential rather than explicit.

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?

Usage context is implied by the 'verbatim, not summarized' framing, which tells an agent to come here when it needs the authentic README rather than search results. There is no explicit when-not or pointer to docs_get_package_info / docs_search_docs for alternative needs, so the agent must reason about the boundary itself.

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