Llms.txt Documentation

🚀 mcpdoc 項目

mcpdoc 是一個用於加載和管理文檔源的工具，支持通過多種方式配置文檔服務器，能方便地查詢文檔信息。

🚀 快速開始

啟動文檔服務器

通過以下命令啟動文檔服務器：

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

此命令將加載並提供 LangGraph Python 文檔。

查詢文檔

啟動服務器後，可以通過以下方式查詢文檔：

/mcp query "請列舉所有支持的模型"

📦 安裝指南

使用 pip 安裝：

pip install mcpdoc

📚 詳細文檔

配置指南

文檔服務器支持多種配置方式，可以靈活地添加和管理文檔源。

使用 YAML 配置文件

創建 sample_config.yaml 文件：

# Sample configuration for mcpdoc server
# Each entry must have a llms_txt URL and can optionally include a name
- name: LangGraph Python
  llms_txt: https://langchain-ai.github.io/langgraph/llms.txt

啟動服務器時指定 YAML 配置文件：

mcpdoc --yaml sample_config.yaml

使用 JSON 配置文件

創建 sample_config.json 文件：

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

啟動服務器時指定 JSON 配置文件：

mcpdoc --json sample_config.json

直接指定 URL

可以通過 --urls 參數直接指定文檔源的 URL，格式為 name:url。例如：

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

組合使用

可以將 YAML、JSON 配置文件和 --urls 參數組合使用：

mcpdoc --yaml sample_config.yaml --json sample_config.json --urls LangGraph:https://langchain-ai.github.io/langgraph/llms.txt --urls LangChain:https://python.langchain.com/llms.txt

額外選項

• --follow-redirects：是否跟隨 HTTP 重定向（默認為 False）
• --timeout SECONDS：HTTP 請求超時時間，以秒為單位（默認為 10.0）

示例：

mcpdoc --yaml sample_config.yaml --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": "Another Documentation",
        #     "llms_txt": "https://example.com/llms.txt",
        # },
    ],
    follow_redirects=True,
    timeout=15.0,
)

# 啟動服務器
server.run(transport="stdio")