Memobase

🚀 MemoDB MCP 服務器

MCP 服務器可用於管理 AI 應用的對話上下文與個人知識庫。它藉助模型上下文協議（MCP），提供了用戶數據、對話內容和知識管理的工具，能有效提升 AI 應用的交互體驗和知識管理效率。

🚀 快速開始

MCP 服務器通過模型上下文協議（MCP），為 AI 應用提供了強大的用戶數據、對話內容和知識管理能力。以下是啟動服務器的步驟：

1. 安裝依賴:

npm install

2. 配置環境變量: 創建 .env 文件並設置:

MEMOBASE_API_URL=your_api_url    # API 服務器地址
MEMOBASE_API_KEY=your_api_key    # API 訪問密鑰

3. 構建項目:

npm run build

4. 運行服務器:

# 生產環境
npm start

# 開發環境
npm run dev

✨ 主要特性

用戶管理

• create_user：創建新用戶
• get_user：獲取用戶信息
• update_user：更新用戶信息
• delete_user：刪除用戶

對話數據管理

• insert_blob：插入對話數據
• get_blob：獲取對話數據
• delete_blob：刪除對話數據

知識庫管理

• query_knowledge：查詢知識庫
  • 支持全文搜索
  • 支持按類型、標籤、來源過濾
  • 支持限制返回結果數量
• add_knowledge：添加新知識
  • 支持設置知識來源
  • 支持設置知識類型
  • 支持添加標籤
• update_knowledge：更新已有知識
  • 支持更新內容和元數據
  • 支持修改標籤
• relate_knowledge：創建知識關聯
  • 支持設置關聯類型
  • 支持設置關聯權重

🔧 技術細節

類型安全

• 使用 TypeScript 實現，具備完整的類型定義和檢查，可在編譯時進行錯誤檢測。

錯誤處理

• 擁有全面的錯誤處理機制，能提供詳細的錯誤信息，並進行錯誤日誌記錄。

API 設計

• 基於 JSON - RPC 2.0 協議，採用 RESTful API 風格，接口定義清晰。

可擴展性

• 採用模塊化設計，支持插件式工具註冊，便於添加新功能。

📦 安裝指南

安裝依賴

npm install

配置環境變量

創建 .env 文件並設置：

MEMOBASE_API_URL=your_api_url    # API 服務器地址
MEMOBASE_API_KEY=your_api_key    # API 訪問密鑰

構建項目

npm run build

運行服務器

# 生產環境
npm start

# 開發環境
npm run dev

💻 使用示例

基礎用法

添加知識

const result = await callTool('add_knowledge', {
  uid: 'user123',
  content: '人工智能是計算機科學的一個分支...',
  metadata: {
    source: 'wiki',
    type: 'article',
    tags: ['AI', '計算機科學', '技術']
  }
});

查詢知識

const result = await callTool('query_knowledge', {
  uid: 'user123',
  query: '人工智能',
  filters: {
    types: ['article'],
    tags: ['AI'],
    sources: ['wiki']
  },
  limit: 10
});

關聯知識

const result = await callTool('relate_knowledge', {
  uid: 'user123',
  source_kid: 'knowledge1',
  target_kid: 'knowledge2',
  relation_type: 'related_to',
  weight: 0.8
});

📚 詳細文檔

開發指南

添加新工具

• 在代碼中新增功能模塊，需遵循現有設計模式和命名規範，確保模塊間接口兼容性。

修改配置

• 更新 .env 文件參數值，保持環境變量命名一致，並測試不同配置下的運行效果。

運行測試

• 使用 npm test 執行單元測試，檢查測試覆蓋率報告，定期更新測試用例。

常見問題

• 如何獲取幫助？查看文檔或聯繫支持團隊。
• 遇到錯誤如何處理？檢查日誌文件並參考排錯指南。

📄 許可證

本項目遵循 [許可證名稱] 協議。詳細信息請參閱 LICENSE 文件。