MCP Document Server

🚀 MCP 文档服务器

MCP 文档服务器是一个简单的服务器，实现了 Model Context Protocol (MCP)，可用于文档搜索和检索。它能帮助用户高效地存储和查找文档，提供语义搜索功能，并且兼容 Cursor 等 MCP 客户端。

🚀 快速开始

安装依赖项

npm install

构建 TypeScript 代码

npm run build

启动服务器

npm run stdio

✨ 主要特性

• 文档存储与检索：使用 MCP 进行文档的存储和检索，方便快捷。
• 语义搜索：提供语义搜索功能，让搜索结果更精准。
• 兼容性强：兼容 Cursor 和其他 MCP 客户端。
• 可插拔式架构：支持本地 JSON 文档存储，还能集成 Confluence 工作区文档搜索。
• 格式支持：支持 HTML 格式的文档。

📦 安装指南

安装依赖

npm install

构建代码

npm run build

启动服务

npm run stdio

💻 使用示例

与 Cursor 配合使用

此服务器专为与 Cursor 配合设计，可通过 search 工具使用关键字参数进行文档搜索。

search({
  keyword: "data"
})

创建文档

可直接从 Cursor 创建新文档。

create_document({
  title: "New Confluence Page",
  content: "This is a page created in Confluence",
  serviceId: "confluence"
})

📚 详细文档

文档服务架构

架构基于可插拔式文档服务设计，每个服务实现通用接口用于搜索和检索文档。

本地存储服务

本地存储服务将文档存储在本地文件系统中：

• 文档存储在 data/documents/ 目录（自动创建）
• 元数据存储在 data/documents.json 文件（自动创建）
• 支持 Markdown 和 HTML 格式的内容

Confluence 服务

Confluence 服务使用 Confluence REST API 和 CQL（Confluence 查询语言）搜索工作区文档。要启用此功能，请设置以下环境变量：

# Confluence 配置
export CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki"
export CONFLUENCE_USERNAME="your-email@example.com"
export CONFLUENCE_API_TOKEN="your-api-token"
export CONFLUENCE_SPACE="your-space-key"

您可以在启动服务器之前设置这些变量：

CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki" \
CONFLUENCE_USERNAME="your-email@example.com" \
CONFLUENCE_API_TOKEN="your-api-token" \
CONFLUENCE_SPACE="your-space-key" \
npm run stdio

认证详情

服务使用 Basic 认证，您的电子邮件和 API 令牌。凭据以 Base64 编码格式发送到授权头：

Authorization: Basic <base64-encoded-email:token>

管理文档

本地存储服务会在首次使用时自动创建 data/documents 目录和 data/documents.json 文件。这些文件不在仓库中，按需生成。

扩展服务器

添加新的文档服务

MCP 服务器设计为可扩展。您只需实现 DocumentService 接口即可添加新服务：

interface DocumentService {
  id: string;
  getByKeywords: (keywords: string[]) => Promise<Document[]>;
  createDocument?: (title: string, content: string) => Promise<Document>;
}

要添加新的服务：

1. 在 src/services/ 目录下创建新目录
2. 实现 DocumentService 接口
3. 在 src/services/index.ts 注册您的服务

一些潜在的文档服务实现方向包括：

• Google Drive：连接 Google 驱动器 API 进行文档存储和检索
• OneDrive/SharePoint：集成 Microsoft 的文档服务
• Notion：添加 Notion 工作区支持
• GitHub Wiki：连接到 GitHub 维基百科进行文档管理
• 自定义数据库：将文档存储在 SQL 或 NoSQL 数据库中