使用说明

项目简介: DevDocs 是一个文档抓取和管理工具，旨在帮助开发者快速理解和使用技术文档。它通过智能抓取网站文档，并将其整理为结构化的 Markdown 格式，然后通过内置的 MCP 服务器对外提供文档内容，方便 LLM 应用访问和利用这些信息。

主要功能点:

智能网站文档抓取，支持自定义抓取深度和自动发现子链接。
将抓取的文档内容转换为 Markdown 格式并存储。
内置 MCP 服务器，以标准化的方式提供文档资源和工具，方便 LLM 应用集成。
提供多种工具，例如：
- 获取文档内容: 读取指定 Markdown 文件的完整内容。
- 获取文档章节: 根据章节 ID 获取文档的特定章节内容。
- 获取文档目录: 获取 Markdown 文件的结构化目录。
- 文件搜索: 在所有 Markdown 文件中搜索关键词。
- 标签搜索: 根据元数据标签搜索文件。
- 文件同步: 手动同步文件，更新缓存。
- 获取统计信息: 获取关于 Markdown 文件的统计数据。

安装步骤:

克隆仓库:

git clone https://github.com/cyberagiinc/DevDocs.git
cd DevDocs

运行安装脚本: 根据您的操作系统选择相应的安装脚本。

macOS/Linux:

./fast-markdown-mcp/setup.sh

Windows (使用 Batch Script):

fast-markdown-mcp\setup.bat

启动 DevDocs 服务: 同样根据您的操作系统选择启动脚本。
- macOS/Linux:
```
./start.sh
```
- Windows (使用 Batch Script):
```
start.bat
```
- Windows (使用 PowerShell):
```
.\start.ps1
```

服务器配置 (MCP 客户端配置): 以下 JSON 配置信息用于配置 MCP 客户端以连接 DevDocs 的 MCP 服务器。您需要将此配置添加到您的 MCP 客户端配置中，通常在 'mcpServers' 字段下。

{
  "mcpServers": {
    "fast-markdown": {
      "command": "/path/to/DevDocs/fast-markdown-mcp/venv/bin/python",  // MCP 服务器启动命令：Python 解释器路径，请根据实际安装路径修改
      "args": [
        "-m",
        "fast_markdown_mcp.server",
        "/path/to/DevDocs/storage/markdown"  // MCP 服务器参数：Markdown 文件存储目录路径，请根据实际仓库路径修改
      ],
      "env": {
        "PYTHONPATH": "/path/to/DevDocs/fast-markdown-mcp/src"  // 环境变量：Python 模块搜索路径，指向 fast-markdown-mcp/src 目录
      },
      "disabled": false
    }
  }
}

注意:

请将配置中的 '/path/to/DevDocs' 替换为您本地 DevDocs 仓库的实际绝对路径。
'command' 字段指定了 Python 解释器的路径，用于运行 MCP 服务器脚本。
'args' 字段包含了 MCP 服务器启动所需的参数，其中 '/path/to/DevDocs/storage/markdown' 指定了 Markdown 文件存储的目录。
'env' 字段中的 'PYTHONPATH' 确保 Python 可以找到 'fast_markdown_mcp' 模块。

基本使用方法:

确保 DevDocs 服务已成功启动。MCP 服务器会随 DevDocs 服务一同启动。
在您的 MCP 客户端 (例如，Roo Cline 等兼容 MCP 协议的客户端) 中，配置上述 'fast-markdown' 服务器信息。
使用 MCP 客户端连接到 'fast-markdown' 服务器。
您可以使用客户端提供的工具列表功能，查看 'fast-markdown' 服务器提供的所有工具。
通过调用相应的工具，例如 'read_file'，'get_section'，'search_files' 等，与托管在 MCP 服务器上的 Markdown 文档进行交互，从而在 LLM 应用中利用这些文档内容。
您可以通过 DevDocs 的 Web UI (通常在 'http://localhost:3001' 访问) 进行文档抓取和管理操作，抓取后的文档会自动被 MCP 服务器索引和提供服务。

关键词

使用说明

信息