Uv Docs MCP

🚀 UV 文檔 MCP 服務器

這是一個 MCP 服務器，可對 UV 文檔進行程序化訪問，並通過標準 API 提供服務。該服務器採用現代的層次結構資源結構，將高級文檔部分和詳細命令文檔（含子部分）作為單獨的 MCP 資源公開。同時，工具也經過了優化，許多文檔查詢可通過資源層處理。

🚀 快速開始

需求

確保安裝了 Python 3.13+（MCP SDK 兼容性最低要求為 Python 3.10）。

克隆倉庫

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

設置虛擬環境並安裝依賴項

python3.13 -m venv env
source env/bin/activate   # 在 Windows 上使用：env\\Scripts\\activate
pip install -e .

運行服務器

uv run uv-docs

(如果使用 Claude Desktop 或其他 MCP 客戶端，請相應調整配置。)

✨ 主要特性

• 通過標準 API 對 UV 文檔進行程序化訪問。
• 採用現代層次結構資源結構，公開高級文檔部分和詳細命令文檔。
• 工具經過優化，許多文檔查詢可通過資源層處理。
• 實現版本感知緩存系統，提高性能。

📦 安裝指南

克隆項目

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

創建虛擬環境並安裝依賴

python3.13 -m venv env
source env/bin/activate   # 在 Windows 上使用：env\\Scripts\\activate
pip install -e .

運行服務器

uv run uv-docs

💻 使用示例

暫未提供代碼示例，若有相關需求可進一步補充。

📚 詳細文檔

鏈接

• UV 文檔
• MCP Python SDK

架構

服務器採用模塊化和分層設計，明確分離關注點：

flowchart TD
    Client[MCP 客戶端] --> Server[服務器層]
    Server --> Resources[資源層]
    Server --> Tools[工具層]
    Server --> Prompts[提示層]
    
    Resources --> Cache[緩存系統]
    Tools --> Cache

資源層

使用 uv-docs:// URI 方案提供 UV 文檔。資源按層次結構排列：

• 第 1 層：基礎部分（如 CLI、設置、解析器）
• 第 2 層：特定命令或配置
• 第 3 層：詳細信息或子部分

工具層

實現實用工具，如 update_cache 和 search_documentation。

提示層

提供用於文檔任務的提示模板。

緩存

服務器實現了一個版本感知緩存系統：

• 初始化：服務器啟動時自動初始化緩存。
• 版本檢查：即時文檔版本與緩存版本進行比較。
• 分段緩存：每個文檔部分（如 CLI、設置、解析器）單獨緩存。
• 手動更新：需要時使用 update_cache 工具。

開發

項目結構

uv-docs/
├── src/
│   └── uv_docs/
│       ├── __init__.py
│       ├── server.py         # 服務器設置和路由
│       ├── resources.py      # 資源處理和 MCP 資源接口
│       ├── cache.py          # 版本感知緩存系統
│       ├── prompts.py        # 文檔任務提示模板
│       └── tools.py          # 工具實現（update_cache, search_documentation）
├── pyproject.toml            # 項目配置
└── README.md                # 項目概述（此文件）

構建與發佈

1. 同步依賴項和鎖定文件

uv sync

2. 構建包分發

uv build

3. 發佈到 PyPI

uv publish

注意：通過以下方式設置 PyPI 憑證：

• 令牌：--token 或環境變量 UV_PUBLISH_TOKEN
• 或用戶名/密碼：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

調試

使用 MCP Inspector 以獲得最佳調試體驗：

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

Inspector 會顯示一個瀏覽器調試的 URL。

🔧 技術細節

服務器採用模塊化和分層設計，將不同功能分離到各個層中，如資源層、工具層和提示層。資源層使用 uv-docs:// URI 方案提供 UV 文檔，並按層次結構排列，便於管理和查詢。工具層實現了實用工具，可對文檔進行更新緩存和搜索等操作。提示層提供了文檔任務的提示模板。同時，服務器還實現了版本感知緩存系統，在服務器啟動時自動初始化緩存，通過即時文檔版本與緩存版本的比較，實現分段緩存，提高了系統性能和響應速度。在開發方面，項目有明確的結構，通過 uv 命令可完成同步依賴、構建包分發和發佈到 PyPI 等操作。

📄 許可證

原文檔未提及許可證信息，若有相關內容可補充展示。