🚀 MCP 文档服务器
MCP 文档服务器是一个简单的服务器，它实现了模型上下文协议（MCP），可用于文档搜索和检索。借助该服务器，用户能够高效地存储和查找文档，同时具备语义搜索等实用功能。
🚀 快速开始
安装依赖项
npm install
构建 TypeScript 代码
npm run build
启动服务器
npm run stdio
✨ 主要特性
- MCP 文档管理：使用 MCP 进行文档存储和检索，为文档管理提供标准化解决方案。
- 语义搜索：具备语义搜索功能，可更精准地定位所需文档。
- 客户端兼容：兼容 Cursor 和其他 MCP 客户端，方便用户在不同环境下使用。
- 可插拔式架构：采用可插拔式文档服务架构，支持本地 JSON 文档存储和 Confluence 集成，可搜索工作区文档。
- HTML 支持：支持 HTML 格式的文档。
📦 安装指南
- 安装依赖项：
npm install
- 构建 TypeScript 代码：
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
认证详情
服务使用基本认证，使用您的电子邮件和 API 令牌。凭据以 Base64 编码字符串形式发送在授权头中：
Authorization: Basic
管理文档
本地存储服务自动创建 data/documents 目录和 data/documents.json 文件（按需生成）。这些文件不在仓库中，并按需自动生成。
扩展服务器
添加新的文档服务
MCP 服务器设计为可扩展。您可以通过实现 DocumentService 接口轻松添加新文档服务：
interface DocumentService {
id: string;
getByKeywords: (keywords: string[]) => Promise<Document[]>;
createDocument?: (title: string, content: string) => Promise<Document>;
}
要添加新服务：
- 在
src/services/目录下为您的服务创建新目录 - 实现
DocumentService接口 - 在
src/services/index.ts注册您的服务
一些可能的文档服务实现方向：
- Google Drive：连接到 Google 驱动器 API 进行文档存储和检索
- OneDrive/SharePoint：集成 Microsoft 的文档服务
- Notion：添加 Notion 工作区支持
- GitHub Wiki：连接到 GitHub 维基百科进行文档管理
- 自定义数据库：将文档存储在 SQL 或 NoSQL 数据库中