Skip to main content
Glama
aserper

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

by aserper

pypi_metadata

Retrieve Python package metadata from PyPI including version numbers, documentation URLs, and project links for accurate code generation.

Instructions

        Get Python package metadata from PyPI (name, version, URLs, summary).

        USE THIS WHEN: You need basic package info, version numbers, or links to external documentation.

        RETURNS: Package metadata ONLY - does NOT include actual documentation content.
        For full documentation, use fetch_pypi_docs instead.

        The response includes:
        - Package name, version, summary
        - Documentation URL (docs_url) - can be passed to WebFetch for external docs
        - Project URLs (homepage, repository, etc.)

        Args:
            package: PyPI package name (e.g., "requests", "flask", "django")
            ignore_verification: Skip PyPI verification check if VERIFIED_BY_PYPI is enabled

        Example: pypi_metadata("requests") → Returns metadata with docs_url pointing to readthedocs
        

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
packageYes
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 what the tool does (retrieves metadata), what it doesn't do (no documentation content), and includes an example of the response format. However, it doesn't mention potential failure modes, rate limits, or authentication requirements, which would be helpful for a tool interacting with an external API.

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, returns, response details, args, example), front-loading key information. Every sentence earns its place by providing essential guidance without redundancy, making it easy to scan and understand quickly.

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 (2 parameters, no output schema, no annotations), the description provides comprehensive context about what the tool does, when to use it, what it returns, and parameter semantics. The main gap is the lack of output schema, so the description doesn't fully document the response structure, though it lists key fields. For a metadata retrieval tool, this is reasonably complete.

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?

With 0% schema description coverage, the description must compensate for the lack of parameter documentation in the schema. It provides clear explanations for both parameters: 'package' is described with examples ('requests', 'flask', 'django'), and 'ignore_verification' is explained with context about PyPI verification checks. The description adds significant value beyond the bare schema.

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 ('Get Python package metadata') and resources ('from PyPI'), listing the exact information retrieved (name, version, URLs, summary). It distinguishes itself from sibling tools like fetch_pypi_docs by specifying it returns metadata only, not documentation content.

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 includes an explicit 'USE THIS WHEN' section that provides clear guidance on when to use this tool ('You need basic package info, version numbers, or links to external documentation') and when not to use it ('does NOT include actual documentation content. For full documentation, use fetch_pypi_docs instead'), directly naming an alternative sibling tool.

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