Skip to main content

MCP server for automatic Python package documentation context

Project description

AutoDocs MCP Server

AutoDocs MCP Server automatically provides AI assistants with contextual, version-specific documentation for Python project dependencies, eliminating manual package lookup and providing more accurate coding assistance.

Features

  • Automatic Dependency Scanning: Parse pyproject.toml files and extract dependency information
  • Version-Specific Caching: Cache documentation based on resolved package versions
  • Graceful Degradation: Handle malformed dependencies and network issues gracefully
  • Rich Context: Provide AI assistants with both primary package and dependency documentation
  • FastMCP Integration: Built with FastMCP for seamless integration with AI tools like Cursor

Installation

# Using uv (recommended)
uv tool install autodocs-mcp

# Using pip
pip install autodocs-mcp

Usage

As an MCP Server

Configure in your Cursor Desktop settings:

{
  "mcpServers": {
    "autodocs-mcp": {
      "command": "uv",
      "args": ["run", "--from", "autodocs-mcp", "autodocs-mcp"],
      "env": {
        "AUTODOCS_CACHE_DIR": "/path/to/cache"
      }
    }
  }
}

Development

# Install dependencies
uv sync --all-extras

# Run tests
uv run pytest

# Run linting
uv run ruff check

# Start development server
uv run hatch run dev

MCP Tools

scan_dependencies

Scans project dependencies from pyproject.toml files.

Parameters:

  • project_path (optional): Path to project directory (defaults to current directory)

Returns:

  • Project metadata and dependency specifications
  • Graceful degradation information for malformed dependencies

get_package_docs (Coming Soon)

Retrieves formatted documentation for Python packages.

Configuration

Environment variables:

  • AUTODOCS_CACHE_DIR: Cache directory location (default: ~/.autodocs/cache)
  • AUTODOCS_MAX_CONCURRENT: Maximum concurrent PyPI requests (default: 10)
  • AUTODOCS_REQUEST_TIMEOUT: Request timeout in seconds (default: 30)
  • AUTODOCS_LOG_LEVEL: Logging level (default: INFO)

Architecture

  • FastMCP Server: Handles MCP protocol communication
  • Dependency Parser: Parses pyproject.toml with graceful error handling
  • Documentation Fetcher: Retrieves package info from PyPI (coming soon)
  • Cache Manager: Version-based caching system (coming soon)

Development Status

This is currently in Priority 1: Core Validation phase:

  • ✅ Basic project setup with hatch/uv
  • ✅ Minimal viable dependency parser
  • ✅ Basic FastMCP integration
  • scan_dependencies MCP tool
  • 🚧 Testing with real projects

Coming next: Documentation fetching, version-based caching, and rich dependency context.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autodoc_mcp-0.1.6.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autodoc_mcp-0.1.6-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file autodoc_mcp-0.1.6.tar.gz.

File metadata

  • Download URL: autodoc_mcp-0.1.6.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for autodoc_mcp-0.1.6.tar.gz
Algorithm Hash digest
SHA256 aaf1b417df60f5cafd3bf45fe4a9b48ae8e5fb4c25bbabe591ab3dd0c3774ca4
MD5 cf82bb88c295ec77fe8329b9dccb4fdc
BLAKE2b-256 16e0ac8064865fafc6096b5359566545a74776518e561411202c7b0e224b183a

See more details on using hashes here.

Provenance

The following attestation bundles were made for autodoc_mcp-0.1.6.tar.gz:

Publisher: ci.yml on bradleyfay/autodoc-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file autodoc_mcp-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: autodoc_mcp-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for autodoc_mcp-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b9aacab2123b7d6a7c978bb990602167f4a1880e9764e72fce2e859775bf9a2a
MD5 6ed52bbd0db88a0820283213679f6b77
BLAKE2b-256 bf9ebf9d64720083c2abdb7f9b149c97f3759b62bd91758f4c8aa7f92cbd594b

See more details on using hashes here.

Provenance

The following attestation bundles were made for autodoc_mcp-0.1.6-py3-none-any.whl:

Publisher: ci.yml on bradleyfay/autodoc-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page