AI导哈

文档访问服务器

一个轻量级的MCP服务器，提供对本地文档文件的直接访问，简化项目特定上下文的获取过程。

  • by Unlock-MCP
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 unlock-mcp/mcp-docs-server

使用说明

MCP文档服务器

一个轻量级的模型上下文协议（MCP）服务器，提供对本地文档文件的直接访问，这是针对特定项目上下文的复杂RAG管道的简单替代方案。

概述

此MCP服务器读取单个markdown文件(context.md)并通过两个简单的工具公开其内容：

  • get_context_overview()：列出所有章节标题
  • search_context(query)：在所有部分中搜索内容

非常适合让LLM访问项目文档，而无需向量数据库或嵌入模型的开销。

特性

  • 零依赖 超越MCP Python SDK
  • 闪电般快速 -直接文件访问，无矢量搜索
  • 简单设置 -适用于GUI和CLI MCP客户端
  • 跨平台 -包括用于macOS/Linux兼容性的shell包装器
  • 稳健的错误处理 -全面的日志记录和调试支持

安装

先决条件

  • Python 3.11+
  • MCP客户端（克劳德桌面、cline等）

设置

  1. 克隆此存储库：
git clone https://github.com/unlock-mcp/mcp-docs-server.git
cd mcp-docs-server
  1. 安装依赖项：
pip install -r requirements.txt
  1. 创建文档文件：
# Create a context.md file in the project root with your documentation
echo "# My Project Docs\n\nThis is my documentation." > context.md

客户端配置

适用于Claude Desktop（GUI客户端）

使用shell包装器进行可靠执行：

  1. 使包装器可执行：
chmod +x run_context_server.sh
  1. 安装服务器：
mcp install ./run_context_server.sh --name "docs-server"

适用于cline和CLI客户端

添加到MCP配置文件中：

{
  "mcpServers": {
    "docs-server": {
      "timeout": 60,
      "type": "stdio",
      "command": "/opt/homebrew/bin/python3.11",
      "args": [
        "/path/to/mcp-docs-server/mcp_context_server.py"
      ],
      "env": {}
    }
  }
}

注意：更新Python路径以匹配您的系统(which python3.11)

发展

测试

使用MCP开发工具进行轻松测试：

mcp dev ./run_context_server.sh

这将启动一个基于web的检查器来测试您的服务器。

调试

服务器登录到stderr进行调试。如果遇到问题，请检查MCP客户端的日志。

常见问题：

  • ENOENT 错误：使用shell包装器或指定完整的Python路径
  • 导入错误：确保 mcp[cli]>=1.2.0 已安装
  • 文件未找到：验证 context.md 存在于项目根目录中

文件结构

mcp-docs-server/
├── mcp_context_server.py      # Main server implementation
├── run_context_server.sh      # Shell wrapper for GUI clients
├── requirements.txt           # Python dependencies
├── context.md                 # Your documentation (create this)
└── README.md                  # This file

用法

配置后，您可以在MCP客户端中使用这些工具：

  • 获取概述：“文档中有哪些部分？”
  • 搜索内容：“在文档中搜索身份验证”
  • 具体查询：“如何配置数据库？”

教程

有关从头开始构建此服务器的完整演练，包括常见陷阱和解决方案，请参阅完整教程： 放弃RAG：为您的文档构建本地MCP服务器

贡献

欢迎投稿！请随时提交问题和拉取请求。

许可证

MIT许可证-有关详细信息，请参阅许可证文件。

内置于❤️ 由 解锁MCP 团队。

相关 MCP