MCP Plugable Document Server

🚀 MCP 文檔服務器

MCP 文檔服務器是一個簡單的服務器，它實現了模型上下文協議（MCP），可用於文檔搜索和檢索。藉助該服務器，用戶能夠高效地存儲和查找文檔，同時具備語義搜索等實用功能。

🚀 快速開始

安裝依賴項

npm install

構建 TypeScript 代碼

npm run build

啟動服務器

npm run stdio

✨ 主要特性

• MCP 文檔管理：使用 MCP 進行文檔存儲和檢索，為文檔管理提供標準化解決方案。
• 語義搜索：具備語義搜索功能，可更精準地定位所需文檔。
• 客戶端兼容：兼容 Cursor 和其他 MCP 客戶端，方便用戶在不同環境下使用。
• 可插拔式架構：採用可插拔式文檔服務架構，支持本地 JSON 文檔存儲和 Confluence 集成，可搜索工作區文檔。
• HTML 支持：支持 HTML 格式的文檔。

📦 安裝指南

1. 安裝依賴項：

npm install

2. 構建 TypeScript 代碼：

npm run build

3. 啟動服務器：

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 <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 數據庫中