Documentation Markdown Converter

🚀 MCP 文档服务器（MCPDoc）

MCP 文档服务器（MCPDoc）是一款用于合并和管理多个文档源的工具。它支持通过 YAML 或 JSON 配置文件加载文档源，也可以直接指定 URL，同时还支持 HTTP 重定向和超时设置。

🚀 快速开始

📦 安装

使用以下命令安装 MCPDoc：

pip install mcpdoc

▶️ 运行

默认情况下，文档服务器会从 llms.txt 文件中定义的 URL 加载文档，并提供一个简单的命令行界面（CLI）来启动文档服务器。

💻 使用示例

⌨️ 命令行用法

mcpdoc [--yaml CONFIG_YAML] [--json CONFIG_JSON] [--urls URL_STRING...] [--follow-redirects] [--timeout SECONDS]

选项说明：

• --yaml CONFIG_YAML：使用 YAML 配置文件加载文档源。
• --json CONFIG_JSON：使用 JSON 配置文件加载文档源。
• --urls URL_STRING...：直接指定文档源的 URL，格式为 name:url 或纯 URL。
• --follow-redirects：启用 HTTP 重定向（默认关闭）。
• --timeout SECONDS：设置 HTTP 请求超时时间（默认 10.0 秒）。

命令行示例：

1. 使用 YAML 配置文件

mcpdoc --yaml sample_config.yaml

2. 使用 JSON 配置文件

mcpdoc --json sample_config.json

3. 直接指定 URL

mcpdoc --urls LangGraph:https://langchain-ai.github.io/langgraph/llms.txt

4. 组合并使用多种方法

mcpdoc --yaml sample_config.yaml --json sample_config.json --follow-redirects --timeout 15

🐍 编程使用

from mcpdoc.main import create_server

# 创建一个带有文档源的服务器
server = create_server(
    [
        {
            "name": "LangGraph Python",
            "llms_txt": "https://langchain-ai.github.io/langgraph/llms.txt",
        },
        # 可以添加多个文档源
        # {
        #     "name": "另一个文档",
        #     "llms_txt": "https://example.com/llms.txt",
        # },
    ],
    follow_redirects=True,
    timeout=15.0,
)

# 运行服务器
server.run(transport="stdio")

🛠️ 与其他工具集成

🔌 集成到 VS Code

1. 安装 Claude Code。
2. 在终端运行以下命令以将 MCP 服务器添加到项目中：

claude mcp add-json langgraph-doc '{"type":"stdio","command":"uvx" ,"args":["--from", "mcpdoc", "mcpdoc", "--urls", "langgraph:https://langchain-ai.github.io/langgraph/llms.txt"]}' -s local

3. 更新 ~/.claude.json 文件。
4. 启动 Claude Code 并运行以下命令以查看工具：

$ Claude
$ /mcp 

🔗 集成到 MCP 代理（MCP Proxy）

1. 在终端中启动文档服务器：

uvx serve mcpdoc.cli:main --from mcpdoc

2. 然后在 MCP 代理中使用以下命令来加载文档源：

llm use mcpdoc -- install https://langchain-ai.github.io/langgraph/llms.txt

📚 详细文档

📄 配置文件格式

YAML 示例（sample_config.yaml）

# 示例配置文件，用于 mcp-mcpdoc 服务器
# 每个条目必须包含 llms_txt URL 和可选的 name
- name: LangGraph Python
  llms_txt: https://langchain-ai.github.io/langgraph/llms.txt

JSON 示例（sample_config.json）

[
  {
    "name": "LangGraph Python",
    "llms_txt": "https://langchain-ai.github.io/langgraph/llms.txt"
  }
]

✨ 主要特性

• 提供多个文档源的合并和管理。
• 支持通过 YAML 或 JSON 配置文件加载文档源。
• 支持直接指定 URL，格式为 name:url 或纯 URL。
• 支持 HTTP 重定向和超时设置。