MCP-文档检索服务器

Name: MCP-文档检索服务器
Author: qpd-v

作者：qpd-v128 星标更新：2025-02-20

安装使用来源：spider==github.com

项目介绍

MCP-Ragdocs

这是一个模型上下文协议（MCP）服务器，它使用向量数据库（Qdrant）来实现语义搜索和文档检索。该服务器允许您从URL或本地文件添加文档，并通过自然语言查询进行搜索。

快速安装指南

全局安装包：

npm install -g @qpd-v/mcp-server-ragdocs

启动Qdrant（使用Docker）：

docker run -p 6333:6333 -p 6334:6334 qdrant/qdrant

确保Ollama正在运行默认嵌入模型：
```
ollama pull nomic-embed-text
```

添加到您的配置文件中：

对于Cline：%AppData%\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json
对于Roo-Code：%AppData%\Roaming\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json
对于Claude Desktop：%AppData%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "ragdocs": {
      "command": "node",
      "args": ["C:/Users/YOUR_USERNAME/AppData/Roaming/npm/node_modules/@qpd-v/mcp-server-ragdocs/build/index.js"],
      "env": {
        "QDRANT_URL": "http://127.0.0.1:6333",
        "EMBEDDING_PROVIDER": "ollama",
        "OLLAMA_URL": "http://localhost:11434"
      }
    }
  }
}

验证安装：

# 检查Qdrant是否在运行
curl http://localhost:6333/collections

# 检查Ollama是否有模型
ollama list | grep nomic-embed-text

版本

当前版本：0.1.6

功能

从URL或本地文件添加文档
将文档存储在向量数据库中以进行语义搜索
使用自然语言搜索文档
列出所有文档来源

安装

使用npm全局安装：

npm install -g @qpd-v/mcp-server-ragdocs

这将在您的全局npm目录中安装服务器，您需要在下面的配置步骤中使用它。

要求

Node.js 16或更高版本
Qdrant（本地或云）
嵌入之一：
- 本地运行的Ollama（默认，免费）
- OpenAI API密钥（可选，付费）

Qdrant设置选项

选项1：本地Qdrant

使用Docker（推荐）：

docker run -p 6333:6333 -p 6334:6334 qdrant/qdrant

或从Qdrant网站下载

选项2：Qdrant Cloud

在Qdrant Cloud创建账户
创建一个新的集群
从仪表板获取您的集群URL和API密钥
在您的配置中使用这些信息（参见下文配置部分）

配置

该服务器可以与Cline/Roo和Claude Desktop一起使用。它们之间的配置略有不同：

Cline配置

添加到您的Cline设置文件（%AppData%\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json）和/或添加到您的Roo-Code设置文件（%AppData%\Roaming\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json）：

使用npm全局安装（推荐）：

{
		"mcpServers": {
				"ragdocs": {
						"command": "node",
      "args": ["C:/Users/YOUR_USERNAME/AppData/Roaming/npm/node_modules/@qpd-v/mcp-server-ragdocs/build/index.js"],
      "env": {
        "QDRANT_URL": "http://127.0.0.1:6333",
        "EMBEDDING_PROVIDER": "ollama",
        "OLLAMA_URL": "http://localhost:11434"
      }
    }
  }
}

对于OpenAI而不是Ollama：

{
		"mcpServers": {
				"ragdocs": {
						"command": "node",
      "args": ["C:/Users/YOUR_USERNAME/AppData/Roaming/npm/node_modules/@qpd-v/mcp-server-ragdocs/build/index.js"],
      "env": {
        "QDRANT_URL": "http://127.0.0.1:6333",
        "EMBEDDING_PROVIDER": "openai",
        "OPENAI_API_KEY": "your-openai-api-key"
      }
    }
  }
}

使用本地开发设置：

{
		"mcpServers": {
				"ragdocs": {
						"command": "node",
						"args": ["PATH_TO_PROJECT/mcp-ragdocs/build/index.js"],
						"env": {
								"QDRANT_URL": "http://127.0.0.1:6333",
								"EMBEDDING_PROVIDER": "ollama",
								"OLLAMA_URL": "http://localhost:11434"
						}
				}
		}
}

Claude Desktop配置

添加到您的Claude Desktop配置文件：

Windows：%AppData%\Claude\claude_desktop_config.json
macOS：~/Library/Application Support/Claude/claude_desktop_config.json

Windows设置与Ollama（使用完整路径）：

{
  "mcpServers": {
    "ragdocs": {
      "command": "C:\\Program Files\\nodejs\\node.exe",
      "args": [
        "C:\\Users\\YOUR_USERNAME\\AppData\\Roaming\\npm\\node_modules\\@qpd-v/mcp-server-ragdocs\\build\\index.js"
      ],
      "env": {
								"QDRANT_URL": "http://127.0.0.1:6333",
								"EMBEDDING_PROVIDER": "ollama",
								"OLLAMA_URL": "http://localhost:11434"
						}
				}
		}
}

Windows设置与OpenAI：

{
		"mcpServers": {
				"ragdocs": {
						"command": "C:\\Program Files\\nodejs\\node.exe",
						"args": [
								"C:\\Users\\YOUR_USERNAME\\AppData\\Roaming\\npm\\node_modules\\@qpd-v/mcp-server-ragdocs\\build\\index.js"
						],
						"env": {
								"QDRANT_URL": "http://127..0.1:6333",
								"EMBEDDING_PROVIDER": "openai",
								"OPENAI_API_KEY": "your-openai-api-key"
						}
				}
		}
}

macOS设置与Ollama：

{
		"mcpServers": {
				"ragdocs": {
						"command": "/usr/local/bin/node",
						"args": [
								"/usr/local/lib/node_modules/@qpd-v/mcp-server-ragdocs/build/index.js"
						],
						"env": {
								"QDRANT_URL": "http://127.0.0.1:6333",
								"EMBEDDING_PROVIDER": "ollama",
								"OLLAMA_URL": "http://localhost:11434"
						}
				}
		}
}

Qdrant Cloud配置

对于Cline或Claude Desktop，当使用Qdrant Cloud时，修改env部分：

与Ollama：

{
		"env": {
				"QDRANT_URL": "https://your-cluster-url.qdrant.tech",
				"QDRANT_API_KEY": "your-qdrant-api-key",
				"EMBEDDING_PROVIDER": "ollama",
				"OLLAMA_URL": "http://localhost:11434"
		}
}

与OpenAI：

{
		"env": {
				"QDRANT_URL": "https://your-cluster-url.qdrant.tech",
				"QDRANT_API_KEY": "your-qdrant-api-key",
				"EMBEDDING_PROVIDER": "openai",
				"OPENAI_API_KEY": "your-openai-api-key"
		}
}

环境变量

Qdrant配置

QDRANT_URL（必需）：您的Qdrant实例的URL
- 对于本地：http://localhost:6333
- 对于云：https://your-cluster-url.qdrant.tech
QDRANT_API_KEY（对于云是必需的）：您的Qdrant Cloud API密钥

嵌入配置

EMBEDDING_PROVIDER（可选）：选择'ollama'（默认）或'openai'
EMBEDDING_MODEL（可选）：
- 对于Ollama：默认为'nomic-embed-text'
- 对于OpenAI：默认为'text-embedding-3-small'
OLLAMA_URL（可选）：您的Ollama实例的URL（默认为http://localhost:11434）
OPENAI_API_KEY（如果使用OpenAI则必需）：您的OpenAI API密钥

可用工具

add_documentation
- 从URL向RAG数据库添加文档
- 参数：
  - url：要获取的文档的URL
search_documentation
- 搜索存储的文档
- 参数：
  - query：搜索查询
  - limit（可选）：返回的最大结果数（默认：5）
list_sources
- 列出当前存储的所有文档来源
- 不需要参数

示例用法

在Claude Desktop或其他兼容MCP的客户端中：

添加文档：

添加此文档：https://docs.example.com/api

搜索文档：

搜索文档中的认证信息

列出来源：

有哪些可用的文档来源？

开发

克隆仓库：

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

安装依赖：

npm install

构建项目：

npm run build

本地运行：

npm start

许可证

MIT

故障排除

常见问题

Qdrant连接错误
```
错误：无法连接到http://localhost:6333上的Qdrant
```
- 检查Docker是否在运行
- 验证Qdrant容器是否在运行：docker ps | grep qdrant
- 尝试重启容器
Ollama模型缺失
```
错误：未找到模型nomic-embed-text
```
- 运行：ollama pull nomic-embed-text
- 验证模型已安装：ollama list
配置路径问题
- Windows：替换YOUR_USERNAME为您实际的Windows用户名
- 检查文件权限
- 验证路径是否存在
npm全局安装问题
- 尝试使用管理员权限安装
- 检查npm是否在PATH中：npm -v
- 验证全局安装：npm list -g @qpd-v/mcp-server-ragdocs

对于其他问题，请检查：

Docker日志：docker logs $(docker ps -q --filter ancestor=qdrant/qdrant)
Ollama状态：ollama list
Node.js版本：node -v（应为16或更高版本）

贡献

欢迎贡献！请随时提交Pull Request。