Kollektiv MCP

🚀 Kollektiv MCP 項目

Kollektiv MCP 是一個基於 Cloudflare Workers 運行的遠程模型上下文協議（MCP）服務器。它允許用戶通過兼容 MCP 的 IDE，在自己的文檔上使用 RAG 技術，實現高效的文檔分析與數據檢索。

🚀 快速開始

安裝依賴

使用 npm 或 yarn 安裝項目所需的依賴：

npm install
# 或者
yarn install

啟動服務器

在安裝完依賴後，啟動 MCP 服務器：

npm run dev
# 或者
yarn dev

接口定義

MCP 服務器提供以下關鍵接口：

• DocumentAnalyzer：用於分析和處理文檔內容。
• Configurator：負責配置和管理服務器參數。

✨ 主要特性

Kollektiv MCP 服務器使用戶能夠通過 IDE（如 Cursor、Windsurf、Claude Desktop 或其他與 MCP 兼容的客戶端）在其自己的文檔上使用 RAG（Retrieval-Augmented Generation）。

📦 安裝指南

連接 MCP 服務器

要在項目中連接到 MCP 服務器，您可以按照以下步驟操作：

1. 安裝客戶端庫：

   npm install @kollektiv/mcp-client
   # 或者
   yarn add @kollektiv/mcp-client
   

2. 配置連接參數： 更新項目的環境變量（.env）文件，添加以下內容：

   MCP_ENDPOINT=http://localhost:8000
   

3. 使用客戶端： 在代碼中引入並初始化 MCP 客戶端：

   import { KollektivMCP } from '@kollektiv/mcp-client';
   
   const mcp = new KollektivMCP({
     endpoint: process.env.MCP_ENDPOINT,
   });
   
   // 示例調用
   await mcp.analyzeDocument('your_document_content');
   

🔧 技術細節

依賴管理

項目使用 tsconfig.json 和 package.json 來管理 TypeScript 配置和依賴項。我們推薦使用以下工具進行開發：

• 代碼編輯器：VS Code
• 構建工具：npm scripts 或 yarn

項目結構

kollektiv-mcp/
├── types/          # 類型定義
├── src/
│   ├── main.ts    # 核心業務邏輯
└── public/        # 靜態資源

架構

Kollektiv MCP 服務器由以下幾個關鍵組件組成：

• OAuth 提供程序 (workers-oauth-provider 和 supabase)：負責處理身份驗證和授權。
• 類型定義 (types)：確保代碼的強類型安全性和一致性。
• 核心業務邏輯 (src/main.ts)：實現 MCP 協議的具體功能，如文檔分析和數據檢索。

📄 許可證

該庫根據 Apache License 2.0 發佈。如需商業支持或其他許可方式，請聯繫：azuev@outlook.com

⚠️ 重要提示

該 MCP 服務器目前仍處於開發階段，尚未準備好用於生產環境。

💡 使用建議

• 身份驗證：所有外部 API 調度必須通過 OAuth 進行身份驗證。
• 數據隔離：確保每個用戶的文檔處理是相互隔離的，防止數據洩露。