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
| Name | Required | Description | Default |
|---|---|---|---|
| package | Yes | ||
| max_bytes | No | ||
| ignore_verification | No |