UV Documentation MCP Server
2025.03.21
2
Python文档服务开发工具开发效率
UV Documentation MCP Server 是一个提供程序化访问 UV 文档的 MCP 服务器，通过标准化的 API 提供文档内容。该服务器采用模块化和分层设计，将文档内容以资源的形式暴露，支持从高级文档部分到详细命令文档（包括子部分）的查询。
View on GitHub
Overview
产品定位
UV Documentation MCP Server 旨在为开发者提供程序化访问 UV 文档的能力，通过标准化的 API 和分层资源结构，使得文档查询更加高效和灵活。
核心功能
- 分层资源结构：
- 提供基于
uv-docs://URI 方案的文档资源访问，支持多级查询（基础部分、命令级别、子部分级别）。 -
每个资源返回 JSON 数据，包含详细的元数据和文档内容。
-
工具层：
- update_cache：更新文档缓存（如果在线版本有变化）。
-
search_documentation：实时搜索 UV 文档。
-
提示层：
-
提供预构建的提示模板，用于生成文档摘要（如
summarize-docs提示）。 -
缓存系统：
- 版本感知的缓存系统，优化文档检索性能。
- 支持自动和手动更新缓存。
适用场景
- 开发者工具集成：将 UV 文档集成到开发工具或 IDE 中，提供实时文档查询功能。
- AI 辅助开发：为 AI 助手提供结构化的文档资源，支持自动生成文档摘要或回答开发问题。
- 文档自动化：通过程序化访问文档内容，支持自动化文档生成或更新。
工具列表
- update_cache：
- 功能：更新文档缓存，确保缓存内容与在线版本一致。
-
输入：
{"force": false}（可选参数，强制更新）。 -
search_documentation：
- 功能：实时搜索 UV 文档内容。
-
输入：
{"query": "search query"}（搜索关键词）。 -
summarize-docs（提示模板）：
- 功能：生成文档部分的摘要。
- 输入：
{"section": "cli|settings|resolver"}（可选参数，指定文档部分）。
常见问题解答
- 如何更新文档缓存？
-
使用
update_cache工具，支持自动或手动更新。 -
如何调试服务器？
-
使用 MCP Inspector 工具进行调试：
npx @modelcontextprotocol/inspector uv --directory /path/to/uv-docs run uv-docs。 -
如何配置 MCP 服务器？
- 根据开发或发布环境修改 MCP 服务器配置（参考文档中的配置示例）。
使用教程
使用依赖
- 安装 Python 3.13+（最低支持 3.10）：
- 确保系统已安装 Python 3.13 或更高版本。
安装教程
-
克隆仓库：
bash git clone https://github.com/StevenBtw/uv-docs-mcp.git cd uv-docs-mcp -
设置虚拟环境并安装依赖：
bash python3.13 -m venv env source env/bin/activate # Windows 使用: env\\Scripts\\activate pip install -e . -
运行服务器：
bash uv run uv-docs
调试方式
- 使用 MCP Inspector 调试：
bash npx @modelcontextprotocol/inspector uv --directory /path/to/uv-docs run uv-docs - 检查浏览器中显示的调试 URL。
许可证
None