Memory Bank MCP

🚀 メモリバンク

メモリバンクは、コマンドラインベースのツールで、ソフトウェアプロジェクトのコンテキスト情報を管理および追跡するために設計されています。複数のMarkdownファイルを維持することで、プロジェクトの状態、進捗、および決定履歴を記録します。ユーザーはコマンドラインでこれらの機能を呼び出すことができ、または自分のコードベースに統合することもできます。

🚀 クイックスタート

メモリバンクの初期化

プロジェクトのルートディレクトリで以下のコマンドを実行して、新しいメモリバンクを初期化します。

memory-bank-mcp initialize_memory_bank path=./memory-bank

これにより、./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=code

✨ 主な機能

メモリバンクのファイル構造

メモリバンクは、以下のMarkdownファイルを使用して情報を整理します。

• product-context.md：プロジェクトの概要、目標、および技術選択を記録します。
• active-context.md：現在の状態、既知の問題、および次の作業を追跡します。
• progress.md：時間順にプロジェクトの更新とマイルストーンを記録します。
• decision-log.md：重要な決定とそのコンテキスト、選択肢、および結果を記録します。
• system-patterns.md：システムアーキテクチャとコードの設計パターンをまとめます。

モードシステム

メモリバンクは、複数の操作モードをサポートしています。

• code：コード実装に集中します。
• ask：質問への回答に集中します。
• architect：システム設計に集中します。
• debug：問題のデバッグに集中します。
• test：テストに集中します。

状態接頭辞システム

メモリバンクは、ユーザーがその実行状態をリアルタイムで把握できるように、状態インジケータを実装しています。

• [MEMORY BANK: ACTIVE]：メモリバンクが準備完了し、コンテキストサポートを提供しています。
• [MEMORY BANK: INACTIVE]：メモリバンクが準備できていないか、設定が正しくないです。
• [MEMORY BANK: UPDATING]：メモリバンクが更新中です（UMBコマンドの実行中）。

📦 インストール

このツールはnpmを使用してインストールできます。

npm install -g @aakarsh-sasi/memory-bank-mcp

💻 使用例

基本的な使用法

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

# メモリバンクの初期化
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=code

ライブラリとして

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

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

// サーバーを起動
server.run().catch(console.error);

📚 ドキュメント

コードの貢献方法については、CONTRIBUTING.mdを参照してください。ここにはコード規約と提出手順が含まれています。

📄 ライセンス

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

変更履歴

このプロジェクトはセマンティックバージョニングに従い、コミットメッセージに基づいて変更履歴を生成します。メインブランチにマージする際には、コミットメッセージに基づいて自動的にバージョン番号が増加します。

• メジャーバージョン：破壊的な変更（BREAKING CHANGEまたは!:が含まれるコミットメッセージ）がある場合に増加します。
• マイナーバージョン：新機能の追加（feat:またはfeat(scope):が含まれるコミットメッセージ）がある場合に増加します。
• パッチバージョン：その他のすべての変更（バグ修正、ドキュメント更新など）に対して増加します。 完全な変更履歴はCHANGELOG.mdファイルを参照してください。