Memory Bank MCP

🚀 メモリバンク

メモリバンクは、プロジェクトのコンテキストを管理および維持するためのシステムです。標準化された構造で情報を整理することで、AIアシスタントがこれらの情報に簡単にアクセスし、更新できるようになります。

🚀 クイックスタート

メモリバンクを使用するには、まず新しいメモリバンクを初期化する必要があります。以下のコマンドを使用して初期化できます。

# メモリバンクの初期化
memory-bank-mcp initialize_memory_bank path=./memory-bank

✨ 主な機能

• 初期化：memory-bank-mcp initialize_memory_bank コマンドを呼び出すことで、新しいメモリバンクを作成します。
• 進捗追跡：track_progress ツールを使用して、プロジェクトの進捗を記録します。
• 決定記録：log_decision ツールを使用して、重要な決定とその背景情報を記録します。
• モード切り替え：必要に応じて、コードモードや問題解決モードなど、異なる操作モードを切り替えます。
• UMBコマンド：セッション中にメモリバンクファイルを一時的に更新しますが、変更をコミットしません。
• モード検出：ユーザー入力に基づいて自動的にモードを検出し、切り替えます。
• ファイル移行ツール：異なるファイル命名規則間での移行に使用します。
• 言語標準化：すべてのメモリバンクファイルは英語で生成され、一貫性を確保します。

📦 インストール

このプロジェクトは、コマンドラインツールとしても、ライブラリとしても使用できます。以下にそれぞれの使用方法を示します。

コマンドラインツールとしての使用

# メモリバンクの初期化
memory-bank-mcp initialize_memory_bank path=./memory-bank

# 進捗追跡
memory-bank-mcp track_progress action="機能実装" description="機能Xを実装しました"

# 決定記録
memory-bank-mcp log_decision title="API設計" context="..." decision="..."

# モード切り替え
memory-bank-mcp switch_mode mode=コード

ライブラリとしての使用

import { MemoryBankServer } from "@movibe/memory-bank-mcp";

// 新しいサーバーインスタンスを作成
const server = new MemoryBankServer();

// サーバーを起動
server.start();

📚 ドキュメント

メモリバンクのデータフロー

1. 初期化：AIアシスタントがメモリバンクサーバーに接続し、メモリバンクを初期化します。
2. ツール呼び出し：AIアシスタントは、メモリバンクサーバーが提供するツールを使用して、メモリバンクファイルを読み書きします。
3. コンテキスト維持：メモリバンクはコンテキスト情報を保持し、AIが以前の決定や進捗を思い出せるようにします。

メモリバンクの構造

メモリバンクは、以下の標準化された構造で情報を整理しています。

• 製品背景：プロジェクトの概要、目標、使用技術、およびアーキテクチャを含みます。
• 現在の状態：現在のプロジェクトの状態、進行中のタスク、既知の問題、および次の操作を記録します。
• 進捗履歴：時間順にプロジェクトの更新とマイルストーンを記録します。
• 決定ログ：重要な決定とその背景、代替案、および結果を記録します。
• システムモード：プロジェクトのアーキテクチャモード、コードモード、およびドキュメントモードを含みます。

バージョン管理

このプロジェクトは、セマンティックバージョニングと約束コミット法に従っています。バージョン番号のルールは以下の通りです。

• メジャーバージョン番号：破壊的な変更がある場合（コミットメッセージに BREAKING CHANGE または !: が付けられた場合）。
• マイナーバージョン番号：新機能が追加された場合（コミットメッセージに feat: または feat(scope): が付けられた場合）。
• パッチバージョン番号：その他のすべての変更（エラー修正、ドキュメント更新など）。

完全な変更履歴は CHANGELOG.md ファイルに記録されています。

🔧 技術詳細

メモリバンクの状態システム

状態コードの説明

• IDLE：サーバーがアイドル状態であることを示します。
• BUSY：サーバーがリクエストを処理中であることを示します。
• ERROR：サーバーがエラーに遭遇したことを示します。

状態照会コマンド

# 現在の状態を照会
memory-bank-mcp get_status

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。具体的な内容は以下の通りです。

MIT License
Copyright (c) 2024, 作者姓名
このソフトウェアの自由な使用、変更、および配布が許可されますが、著作権表示を保持する必要があります。

その他のリソース

• プロジェクトドキュメント
• 問題の提出

メモリバンクの詳細については、プロジェクトホームページ をご覧ください。