Skip to main content
Glama
aserper

RTFD (Read The F*****g Docs)

by aserper

fetch_pypi_docs

Retrieve formatted Python package documentation from PyPI, extracting installation instructions, usage examples, and API references to support development tasks.

Instructions

        Fetch actual Python package documentation from PyPI README/description.

        USE THIS WHEN: You need installation instructions, usage examples, API reference, or quickstart guides.

        BEST FOR: Getting complete, formatted documentation for Python packages.
        Better than using curl or WebFetch because it:
        - Automatically extracts relevant sections (Installation, Usage, Examples)
        - Converts reStructuredText to Markdown
        - Prioritizes most useful content sections
        - Falls back to GitHub README if PyPI description is minimal

        NOT SUITABLE FOR: External documentation sites (use docs_url from pypi_metadata + WebFetch)

        Args:
            package: PyPI package name (e.g., "requests", "numpy", "pandas")
            max_bytes: Maximum content size, default 20KB (increase for large packages)
            ignore_verification: Skip PyPI verification check if VERIFIED_BY_PYPI is enabled

        Returns: JSON with actual documentation content, size, truncation status

        Example: fetch_pypi_docs("requests") → Returns formatted README with installation and usage
        

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
packageYes
max_bytesNo
ignore_verificationNo
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: it extracts relevant sections, converts reStructuredText to Markdown, prioritizes useful content, and falls back to GitHub README. However, it lacks details on error handling, rate limits, or authentication needs, which are common for API tools, leaving some behavioral aspects unclear.

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

Conciseness5/5

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

The description is well-structured with clear sections (purpose, usage guidelines, parameters, returns, example) and front-loaded key information. Every sentence adds value without redundancy, making it efficient for an agent to parse while maintaining completeness.

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

Completeness4/5

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

Given the tool's moderate complexity (3 parameters, no annotations, no output schema), the description is largely complete. It covers purpose, usage, parameters, and return format. However, without an output schema, it could benefit from more detail on the JSON structure (e.g., specific fields like 'content', 'size', 'truncation_status') to fully guide the agent.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate. It adds meaningful semantics for all three parameters: 'package' is explained with examples, 'max_bytes' specifies a default and purpose, and 'ignore_verification' clarifies its conditional use. This goes beyond the bare schema, though it could provide more detail on parameter interactions or constraints.

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

Purpose5/5

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

The description clearly states the tool's purpose with specific verbs ('fetch', 'extracts', 'converts') and resources ('Python package documentation from PyPI README/description'). It explicitly distinguishes itself from alternatives like curl, WebFetch, and external documentation sites, making its scope unambiguous.

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

Usage Guidelines5/5

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

The description provides explicit guidance with dedicated sections: 'USE THIS WHEN' lists specific use cases (installation instructions, usage examples, etc.), 'BEST FOR' clarifies its primary function, and 'NOT SUITABLE FOR' explicitly excludes external documentation sites while suggesting an alternative (docs_url from pypi_metadata + WebFetch). This comprehensive guidance helps the agent choose correctly among siblings.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aserper/RTFD'

If you have feedback or need assistance with the MCP directory API, please join our Discord server