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 重定向和超時設置。