Uv Docs MCP

🚀 UV Documentation MCP Server

A MCP server that provides programmatic access to UV documentation, served via a standard API. This server now exposes high-level documentation sections and detailed command documentation (including subsections) as separate MCP resources using a modern hierarchical resource structure. The tools have been optimized, and many documentation queries are handled through the resource layer.

🔗 Links

• UV Documentation
• MCP Python SDK

🚀 Quick Start

1. Requirements: Ensure Python 3.13+ is installed (the minimum requirement for MCP SDK compatibility is Python 3.10).
2. Clone the repository:

   git clone https://github.com/StevenBtw/uv-docs-mcp.git
   cd uv-docs-mcp
   

3. Set up a virtual environment and install dependencies:

   python3.13 -m venv env
   source env/bin/activate   # On Windows, use: env\\Scripts\\activate
   pip install -e .
   

4. Run the server:

   uv run uv-docs
   

   (If using Claude Desktop or other MCP clients, adjust the configuration accordingly.)

🏗️ Architecture

The server adopts a modular and layered design with clear separation of concerns:

flowchart TD
    Client[MCP Client] --> Server[Server Layer]
    Server --> Resources[Resource Layer]
    Server --> Tools[Tool Layer]
    Server --> Prompts[Prompt Layer]
    
    Resources --> Cache[Cache System]
    Tools --> Cache

• Resource Layer: Provides UV documentation using the uv-docs:// URI scheme. Resources are arranged hierarchically:

  • Level 1: Basic sections (e.g., CLI, Setup, Parser)
  • Level 2: Specific commands or configurations
  • Level 3: Detailed information or subsections

• Tool Layer: Implements utility tools such as update_cache and search_documentation.

• Prompt Layer: Provides prompt templates for documentation tasks.

💾 Cache

The server implements a version-aware cache system:

• Initialization: The cache is automatically initialized when the server starts.
• Version Check: The real-time document version is compared with the cache version.
• Segmented Caching: Each document section (e.g., CLI, Setup, Parser) is cached separately.
• Manual Update: Use the update_cache tool when needed.

🛠️ Development

📁 Project Structure

uv-docs/
├── src/
│   └── uv_docs/
│       ├── __init__.py
│       ├── server.py         # Server setup and routing
│       ├── resources.py      # Resource handling and MCP resource interface
│       ├── cache.py          # Version-aware cache system
│       ├── prompts.py        # Prompt templates for documentation tasks
│       └── tools.py          # Tool implementation (update_cache, search_documentation)
├── pyproject.toml            # Project configuration
└── README.md                # Project overview (this file)

🚀 Build and Publish

1. Synchronize dependencies and lock files:

   uv sync
   

2. Build the package distribution:

   uv build
   

3. Publish to PyPI:

   uv publish
   

⚠️ Important Note

Set your PyPI credentials in the following ways:

• Token: --token or environment variable UV_PUBLISH_TOKEN
• Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

🐞 Debugging

Use the MCP Inspector for the best debugging experience:

npx @modelcontextprotocol/inspector uv --directory /Users/steven/Git/MCP/uv-docs run uv-docs

The Inspector will display a URL for browser debugging.