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 客户端，请相应调整配置。)

🔗 链接

• 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                # 项目概述（此文件）

构建与发布

同步依赖项和锁定文件

uv sync

构建包分发

uv build

发布到 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。