MCP 文档服务器

一个简单的服务器，实现了用于文档搜索和检索的模型上下文协议 (MCP)。

功能特性

• 使用 MCP 进行文档存储和检索
• 语义搜索能力
• 兼容 Cursor 和其他 MCP 客户端
• 可插拔的文档服务架构：
  • 使用 JSON 的本地文档存储
  • Confluence 集成，用于搜索工作区文档
• 支持 HTML

设置

1. 安装依赖：

npm install

2. 构建 TypeScript 代码：

npm run build

3. 启动服务器：

npm run stdio

与 Cursor 一起使用

此服务器旨在与 Cursor 一起使用。 您可以使用带有 keyword 参数的 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 工作区中搜索文档，以实现强大的搜索。 要启用此功能，请设置以下环境变量：

# 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

身份验证详细信息

该服务使用基本身份验证，使用您的电子邮件和 API 令牌。 凭据在 Authorization 标头中作为 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 Drive API 以进行文档存储和检索
• OneDrive/SharePoint: 与 Microsoft 的文档服务集成
• Notion: 添加 Notion 工作区支持
• GitHub Wiki: 连接到 GitHub wiki 以获取文档
• 自定义数据库: 将文档存储在 SQL 或 NoSQL 数据库中