文档服务器

一个简单的文档服务器,用于将Markdown文档提供给AI助手如Claude访问和搜索。

  • by reflex-dev
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 reflex-dev/mcp-example

使用说明

MCP文档服务器

一种简单的方法,使您的文档文件可供Claude等AI助手使用。

这有什么作用?

将此视为 文档的库目录.你有一堆markdown文件(.md 文件)以及文档、指南或注释。此服务器:

  1. 自动查找所有markdown文件
  2. 通过称为MCP(模型上下文协议)的东西使它们可用于AI工具
  3. 让AI助手搜索并阅读您的文档

这就像给克劳德或其他人工智能工具一个文件柜,他们可以在需要信息时打开并阅读。

它是如何工作的(简单解释)

  1. 您将文档文件放在文件夹中 -只需保存您的 .md 有序文件夹中的文件
  2. 服务器会自动找到它们 -无需手动注册每个文件
  3. AI可以读取它们 -人工智能助手现在可以访问和搜索您的文档

真实示例

假设您有“服务1”的文档,其中包含以下文件:

  • user-functions.md -用户功能如何工作
  • call-functions.md -调用功能如何工作
  • calendar-functions.md -日历功能的工作原理

你可以这样组织它们:

docs/
└── service-1/
    ├── user-functions.md
    ├── call-functions.md
    └── calendar-functions.md

就是这样!服务器将自动找到这些文件,并使其可用:

  • docs://service-1/user-functions
  • docs://service-1/call-functions
  • docs://service-1/calendar-functions

快速入门(逐步)

步骤1:安装Python需求

你需要Python 3.10或更高版本 uv (Python包管理器)已安装。

安装 uv 如果你没有:

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

然后安装所需的软件包:

uv pip install mcp

步骤2:添加文档文件

把你的markdown文件放在 docs/ 文件夹。按主题或服务将它们组织在子文件夹中:

docs/
├── service-1/
│   ├── user-functions.md
│   ├── call-functions.md
│   └── calendar-functions.md
├── service-2/
│   └── api-guide.md
└── getting-started/
    └── introduction.md

子文件夹名称(如 service-1)成为类别。

步骤3:连接到Claude Code

最简单的方法是使用Claude Code CLI。在此项目文件夹中,运行:

claude mcp add --transport stdio docs -- uv run python /full/path/to/mcp-example/src/mcp_docs_server.py

替换 /full/path/to/mcp-example 根据您的实际项目路径。

验证它是否已连接:

claude mcp list

您应该看到: docs: ... - ✓ Connected

就是这样!Claude Code现在可以访问您的文档。

添加新文档

随时添加新文档:

  1. 创建新的 .md 将文件放在以下相应文件夹中 docs/
  2. 就是这样!服务器自动查找新文件

例如,要为新服务添加文档:

docs/
└── service-3/          # Create new folder
    └── setup.md        # Add your documentation file

无需重新启动服务器或更改任何代码。

使用Claude代码

如果您使用的是Claude Code(CLI工具),请按照上述步骤3进行操作。服务器已配置并正在运行!

现在,您可以向Claude Code提出以下问题:

  • “列出所有可用的文档资源”
  • “阅读服务-1/用户功能文档”
  • “搜索文档以进行身份验证”

Claude Code将自动访问您的文档文件。

管理服务器

检查服务器是否已连接:

claude mcp list

删除服务器:

claude mcp remove docs

如果需要,请重新添加服务器:

claude mcp add --transport stdio docs -- uv run python /full/path/to/mcp-example/src/mcp_docs_server.py

连接到克劳德桌面

要在Claude Desktop中提供您的文档,请执行以下操作:

  1. 查找您的Claude Desktop配置文件:

    • 苹果电脑: ~/Library/Application Support/Claude/claude_desktop_config.json
    • 视窗: %APPDATA%/Claude/claude_desktop_config.json
  2. 打开文件并添加此内容(替换 /path/to/mcp-example 使用您的实际文件夹路径):

{
  "mcpServers": {
    "docs": {
      "command": "python",
      "args": ["/path/to/mcp-example/src/mcp_docs_server.py"]
    }
  }
}

了解更多