MCP Qdrant Memory

🚀 基於Qdrant持久化的MCP內存服務器

此MCP服務器藉助Qdrant向量數據庫，實現了基於知識圖譜的語義搜索功能，為用戶提供強大且高效的搜索體驗。

🚀 快速開始

此MCP服務器提供了一個基於知識圖譜的語義搜索功能實現，使用Qdrant向量數據庫作為支撐。你可參考後續的安裝配置步驟，快速搭建並使用該服務。

✨ 主要特性

• 🌟 基於圖的知識表示，支持實體及其關係，能更全面地存儲和呈現知識。
• 💾 文件持久化（memory.json），確保數據的穩定性和可恢復性。
• 🔍 使用Qdrant向量數據庫的語義搜索，實現高效的內容檢索。
• 🧠 OpenAI嵌入式模型進行語義相似度計算，提升搜索的準確性。
• 🔒 支持HTTPS協議及反向代理兼容性，保障數據傳輸安全。
• 🐳 Docker環境下的輕鬆部署支持，簡化部署流程。

📦 安裝指南

本地安裝

1. 安裝依賴：

npm install

2. 構建服務端：

npm run build

Docker部署

1. 構建Docker鏡像：

docker build -t mcp-qdrant-memory .

2. 使用環境變量運行容器：

docker run -d \
  -e OPENAI_API_KEY=your-openai-api-key \
  -e QDRANT_URL=https://your-qdrant-server \
  -e QDRANT_API_KEY=your-qdrant-api-key \
  -e QDRANT_COLLECTION_NAME=your-collection-name \
  --name mcp-memory-server \
  mcp-qdrant-memory

💻 使用示例

工具接口

• createEntity(entityData: object): Promise
  創建並存儲實體數據。
• getEntities(query?: string): Promise<Entity[]>
  根據可選查詢參數獲取實體列表，默認返回所有實體。
• updateEntity(entityId, entityData: object): Promise
  更新指定實體的屬性數據。
• deleteEntity(entityId: string): Promise
  刪除特定實體及其相關關係。

基礎用法

// 創建兩個實體
await createEntity({ id: "1", name: "Alice", age: 30 });
await createEntity({ id: "2", name: "Bob", age: 25 });

// 查詢所有實體
const entities = await getEntities();
console.log("所有實體:", entities);

// 更新某個實體
await updateEntity("1", { age: 31 });
const alice = await getEntity("1");
console.log("Alice 更新後年齡:", alice.age); // 輸出: 31

// 刪除一個實體
await deleteEntity("2");
const remainingEntities = await getEntities();
console.log("剩餘實體:", remainingEntities); // 輸出: [ { id: "1", name: "Alice", age: 31 } ]

📚 詳細文檔

環境變量配置

以下為必需的環境變量：

# OpenAI API密鑰用於生成嵌入
OPENAI_API_KEY=your-openai-api-key

# Qdrant服務器URL（支持HTTP和HTTPS）
QDRANT_URL=https://your-qdrant-server

# Qdrant API密鑰（若啟用了身份驗證）
QDRANT_API_KEY=your-qdrant-api-key

# 使用的Qdrant集合名稱
QDRANT_COLLECTION_NAME=your-collection-name

教育與文檔

如需深入理解該系統的內部機制或進行二次開發，建議參考以下資源：

1. 官方文檔
   MCP內存服務器文檔
2. 技術博客系列
   • 知識圖譜構建的最佳實踐
   • Qdrant在語義搜索中的應用
   • 高可用性架構設計
3. 在線教程
   如何使用MCP內存服務器搭建知識檢索系統

貢獻指南

歡迎社區貢獻，參與改進此項目：

1. 代碼倉庫地址

   git clone https://github.com/yourusername/mcp-memory-server.git
   

2. 問題反饋與建議 請在GitHub Issues區提交您遇到的問題或提出功能建議。

🔧 技術細節

• 數據持久化：所有實體及其關係均存儲於memory.json文件中，確保服務重啟後數據不丟失。
• 搜索機制：使用Qdrant向量數據庫實現高效的語義搜索功能，支持文本相似度匹配和內容檢索。
• 錯誤處理：集成完善的事物回滾機制，在網絡波動或服務異常時保證數據一致性。

📄 許可證

本項目遵循MIT開源協議，允許自由使用、修改和分發。

⚠️ 重要提示

在使用該服務前，請確保正確配置環境變量，特別是OpenAI和Qdrant的API密鑰，以保證服務的正常運行。

💡 使用建議

在進行開發和部署時，建議參考官方文檔和技術博客系列，以更好地理解系統的內部機制和最佳實踐。同時，及時在GitHub Issues區反饋問題和提出建議，有助於項目的持續改進。