使用说明
你的医生mcp
一个MCP服务器，让AI助手结构化地访问您的文档。支持markdown和YAML frontmatter、OpenAPI规范、全文搜索、web界面和PDF生成。
安装
从以下位置安装 PyPI:
pip install your-docs-mcp
使用语义搜索（推荐）：
pip install "your-docs-mcp[vector]" --extra-index-url https://download.pytorch.org/whl/cpu
使用PDF生成：
pip install "your-docs-mcp[pdf]"
所有功能：
pip install "your-docs-mcp[vector,pdf]" --extra-index-url https://download.pytorch.org/whl/cpu
PDF生成需要系统包：
- macOS：
brew install pandoc basictex - Ubuntu/Debian：
sudo apt install pandoc texlive-xetex texlive-latex-extra
快速开始
export DOCS_ROOT=/path/to/your/docs
your-docs-server
打开http://localhost:8123浏览您的文档。MCP服务器也在为AI客户端运行。
AI客户端设置
克劳德桌面版 -编辑 ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"docs": {
"command": "your-docs-mcp",
"env": {
"DOCS_ROOT": "/absolute/path/to/your/docs"
}
}
}
}
VS Code -创建 .vscode/mcp.json:
{
"servers": {
"docs": {
"command": "your-docs-mcp",
"env": {
"DOCS_ROOT": "${workspaceFolder}/docs"
}
}
}
}
可用的MCP工具
| 工具 | 说明 |
|---|---|
search_documentation |
带有相关性评分的全文搜索 |
navigate_to |
按URI导航到文档（例如。 docs://guides/quickstart) |
get_table_of_contents |
获取完整的文档层次结构 |
get_document |
检索文档及其元数据 |
search_by_tags |
按标签筛选文档 |
get_all_tags |
列出文档中的所有标签 |
generate_pdf_release |
生成所有文档的PDF |
支持格式
带YAML frontmatter的Markdown：
---
title: Getting Started
tags: [guide, quickstart]
order: 1
---
# Getting Started
Your content here...
OpenAPI 3.x (.yaml 或 .json)也得到了支持。
配置
关键环境变量：
DOCS_ROOT=/path/to/docs # Required: documentation root directory
MCP_DOCS_CACHE_TTL=3600 # Cache TTL in seconds
MCP_DOCS_SEARCH_LIMIT=10 # Max search results
MCP_DOCS_WEB_PORT=8123 # Web server port
LOG_LEVEL=INFO # DEBUG, INFO, WARNING, ERROR
运行模式
your-docs-server # MCP server + web interface
your-docs-mcp # MCP server only
your-docs-web # Web interface only
发展
git clone https://github.com/esola-thomas/your-docs-mcp
cd your-docs-mcp
pip install -e ".[dev,vector,pdf]" --extra-index-url https://download.pytorch.org/whl/cpu
pytest
ruff check .
贡献
看 贡献指南 有关运行测试、代码样式和提交pull请求的详细信息。打开一个 问题 报告错误或请求功能。
许可证
麻省理工学院-见 许可证 了解详情。
