Memory Bank MCP

🚀 內存銀行 MCP 服務器

一個用於遠程內存銀行管理的 Model Context Protocol (MCP) 服務器實現，將傳統基於文件的內存銀行轉變為集中式服務，提供多項目支持和 MCP 協議集成。

🚀 快速開始

Memory Bank MCP Server 是一個將傳統基於文件的內存銀行轉換為集中服務的工具。它提供了通過 MCP 協議訪問遠程內存銀行文件的能力，實現了多項目內存銀行管理，維持一致的文件結構和驗證，並確保項目之間的隔離。

使用 npm 安裝

npm install memory-bank-mcp-server

初始化與啟動

1. 初始化內存銀行：

const MemoryBank = require('memory-bank-mcp-server');
const bank = new MemoryBank({
  root: '/path/to/bank',
  logger: {
    level: 'debug'
  }
});

2. 啟動服務器：

bank.start();

✨ 主要特性

多項目支持

• 項目特定目錄：為每個項目提供獨立的目錄，確保數據隔離。
• 文件路徑限制：對文件路徑進行限制，保障數據安全。
• 內容哈希驗證：通過內容哈希驗證確保數據完整性。
• 多線程安全：支持多線程操作，保證系統的穩定性。
• 錯誤處理：具備完善的錯誤處理機制，及時反饋問題。
• 文檔化 API：提供詳細的 API 文檔，方便開發。

MCP 協議集成

• 支持標準 MCP 操作：兼容標準的 MCP 協議操作。
• 類型安全操作：確保操作的類型安全，減少錯誤。
• 響應式設計：採用響應式設計，提升用戶體驗。
• 日誌記錄和跟蹤：記錄操作日誌，方便問題跟蹤。
• 靈活性和可擴展性：具備良好的靈活性和可擴展性，適應不同需求。

📦 安裝指南

使用 npm 安裝

npm install memory-bank-mcp-server

💻 使用示例

基礎用法

const { Bank } = require('memory-bank-mcp-server');

async function example() {
  const bank = new Bank({
    root: '/path/to/bank',
    logger: {
      level: 'debug'
    }
  });

  await bank.start();

  // 示例操作
  await bank.deposit('key', 'value');
  const value = await bank.withdraw('key');
  console.log(value); // 輸出: value

  await bank.close();
}

example().catch(console.error);

📚 詳細文檔

配置

基本配置

const config = {
  root: process.env.BANK_ROOT || '/path/to/bank',
  port: process.env.PORT || 3000,
  logger: {
    level: process.env.LOG_LEVEL || 'info'
  }
};

環境變量

開發

安裝依賴

npm install

啟動開發服務器

npm run dev

構建項目

npm run build

貢獻

貢獻步驟

1. 叉出倉庫
2. 創建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打開 Pull Request

開發指南

• 使用 TypeScript 編寫所有新代碼
• 維護代碼庫中的類型安全
• 為新功能編寫測試
• 更新相關文檔
• 遵循現有代碼風格和模式

測試

• 編寫單元測試
• 包括多項目場景測試
• 充分測試錯誤情況
• 驗證類型約束
• 適當 mocking 文件系統操作

📄 許可證

該項目在 MIT License 下許可，具體內容請參閱 LICENSE 文件。

致謝

該項目實現了最初由 Cline Memory Bank 文檔化的內存銀行概念，並在遠程能力和多項目支持方面進行了擴展。