产品定位
Pydantic AI 文档服务是一个用于程序化访问和管理 Pydantic-AI 文档的工具,适用于开发者和技术文档维护者。
核心功能
- 更新文档:克隆或拉取最新的 Pydantic-AI 文档仓库。
- 获取文档:通过路径检索特定的文档文件。
- 列出主题:列出文档目录中的文件和子目录。
- 列出变更日志:列出所有可用的变更日志文件。
- 获取变更日志内容:检索特定变更日志文件的内容。
适用场景
- 开发者需要程序化访问 Pydantic-AI 文档。
- 技术文档维护者需要自动化更新和管理文档。
- 需要集成 Pydantic-AI 文档到其他工具或系统中。
工具列表
update_documentation:更新或克隆文档仓库。get_document_by_path:通过路径获取文档内容。list_topics:列出文档目录内容。list_available_changelogs:列出所有变更日志文件。get_changelog_content:获取特定变更日志内容。
使用教程
使用依赖
- 克隆仓库:
git clone
cd pydantic-ai-docs-server- 创建并激活 Python 虚拟环境(推荐 Python 3.12 或更高版本):
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate或使用 uv:
uv venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate- 安装依赖:
uv pip install -e .
# 或使用 pip
# pip install -e .安装教程
运行服务器:
pydantic-ai-docs-server或:
python -m pydantic_ai_docs_server调试方式
服务器通过标准输入/输出(stdio)使用换行分隔的 JSON 消息进行通信。可以通过发送 JSON 请求对象进行交互。
示例请求:
{"type": "list-tools"}或调用工具:
{"type": "call-tool", "tool_name": "update_documentation", "tool_args": {"force_clone": false}}