Memory Bank MCP

🚀 メモリバンクMCPサーバー

Model Context Protocol (MCP) を用いたリモートメモリバンク管理サーバーです。Cline Memory Bank からインスパイアを得ています。

🚀 クイックスタート

Memory Bank MCP Server は、従来のファイルベースのメモリバンクを集中型サービスに変換します。このサービスは、MCP プロトコルを通じたリモートメモリバンクファイルへのアクセスを提供し、多プロジェクトのメモリバンク管理を実現し、一貫したファイル構造と検証を維持し、プロジェクト間の分離を確保します。

✨ 主な機能

多プロジェクトサポート

• プロジェクト固有のディレクトリ
• ファイルパス制限
• 内容のハッシュ検証
• マルチスレッドセキュリティ
• エラー処理
• ドキュメント化されたAPI

MCPプロトコル統合

• 標準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();

📚 ドキュメント

基本設定

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

環境変数

• BANK_ROOT: メモリバンクのルートディレクトリのパス
• PORT: サーバーがバインドするポート
• LOG_LEVEL: ログ記録レベル（debug, info, warn, error, fatal）

💻 使用例

基本的な使用法

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);

🔧 開発

依存関係のインストール

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で記述します。
• コードベースの型安全性を維持します。
• 新機能に対してテストを作成します。
• 関連するドキュメントを更新します。
• 既存のコードスタイルとパターンに従います。

テスト

• ユニットテストを作成します。
• 多プロジェクトシナリオのテストを含めます。
• エラーケースを十分にテストします。
• 型制約を検証します。
• 適切にファイルシステム操作をモックします。

📄 ライセンス

このプロジェクトはMIT Licenseの下でライセンスされています。詳細は LICENSE ファイルを参照してください。

🙏 謝辞

このプロジェクトは、Cline Memory Bank で最初に文書化されたメモリバンクの概念を実装し、リモート機能と多プロジェクトサポートを拡張しています。