mcpdoc

环境要求

• 本地具备 Python 运行环境（项目由 Python 实现）
• 已安装 uv 工具（用于安装与运行）
• 一个支持 MCP 的客户端，如 Cursor、Windsurf、Claude Code/Desktop
• 能访问 llms.txt 文档源地址的网络

安装与启动步骤

1. 1安装 uv

   README 的 Quickstart 只给出安装 uv 的命令，uv 用于后续安装和运行项目；其他安装方式见官方 uv 文档。

   curl -LsSf https://astral.sh/uv/install.sh | sh

   复制

2. 2编写文档源配置

   按 README 的配置格式新建配置文件，内容是文档源列表；每项必须包含 llms_txt，name 可选。

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

   复制

3. 3运行 MCP 服务

   README 的 Programmatic Usage 给出如下片段：先导入 create_server，再以 stdio 传输方式运行服务，供 MCP 客户端连接。

   from mcpdoc.main import create_server
   
   # Run the server
   server.run(transport="stdio")

   复制

关键配置

如何确认成功

MCP 客户端中服务连接成功，并能使用 README 提到的 fetch_docs 工具取回 llms.txt 内的文档内容。

常见问题

注意事项

• README 节选未给出 mcpdoc 自身的完整安装命令，请以官方仓库 README 为准，不要臆造包名与参数。
• Programmatic Usage 片段只给出了导入与 server.run(transport="stdio")，实际使用时需先由 create_server 得到 server 实例。
• 服务通过 stdio 与 MCP 客户端通信，需在具体客户端中完成接入配置。
• llms.txt 仅为索引，详细内容需服务按需抓取对应的 markdown 文件。