Remember Me

🚀 記憶保持システム

このシステムは、MCPベースの言語モデルアプリケーションの会話コンテキストとルールを持続的に管理するためのフレームワークです。MCPサーバーを利用して、様々なタイプのリソースを永続的に保存し、必要に応じて取得することができます。

🚀 クイックスタート

このシステムを使用することで、会話のコンテキストやルールを効果的に管理できます。まずはシステムの概要とアーキテクチャを理解し、APIを通じてリソースの管理を行いましょう。

✨ 主な機能

• リソースの持続的保存：SQLiteを使用して、ルール、コードやテキストの断片、会話の要約などのリソースを永続的に保存します。
• 全面的なAPI：リソースの管理やコンテキストの操作を行うためのAPIを提供します。
• バックアップ機能：コンテキストの状態をバックアップし、必要に応じて復元することができます。

📦 インストール

MCPインスペクターを使用する場合

1. リポジトリをクローンします。

   git clone https://github.com/yourusername/memories.git
   cd memories
   

2. 依存関係をインストールします。

   npm install
   

3. 開発サーバーを起動します。

   npm run dev
   

LLMプラットフォームの設定

LLMを「記憶保持システム」サーバーと通信するように設定します。具体的な手順は選択したLLMフレームワーク（例：OpenAI、Hugging Faceなど）によって異なります。

💻 使用例

基本的な使用法

LLMを使用する際に、「me」コンテキストをロードすることで、グローバルなルール、断片、要約を取得できます。

# コード例は原文を保持
# ここには具体的なコード例が原文にないため、省略

高度な使用法

必要に応じて、追加のコンテキストを指定して、特定の分野のリソースをロードすることができます。

# コード例は原文を保持
# ここには具体的なコード例が原文にないため、省略

📚 ドキュメント

アーキテクチャ

核心コンポーネント

• MyContext：すべての永続的な操作の中央管理モジュールです。
• PersistentResource：すべての保存可能なリソースの基本クラスです。
  • Rule：対話パラメータを定義するコマンドです。
  • Snippet：参照可能なコードまたはテキストの断片です。
  • Summary：会話のコンテキスト情報です。
• Backup：コンテキストの状態を作成および復元するためのシステムです。

データモデル

リソースの保存属性は以下の通りです。

ルールシステム

ルールは構造化されたポリシーフレームワークを採用しています。

• MUST：絶対的な要件です。
• MUST NOT：絶対に禁止されています。
• SHOULD：推奨される方法です。
• SHOULD NOT：推奨されない方法です。
• MAY：オプションの考慮事項です。

API

コンテキスト管理

• my_context()：現在のコンテキストをロードし、追加のコンテキストを追加できます。
• my_context_backup_create()：現在の状態のバックアップを作成します。
• my_context_backup_restore()：以前のバックアップから復元します。
• my_context_backup_list()：利用可能なバックアップを表示します。
• my_context_backup_remove()：特定のバックアップを削除します。
• my_context_backup_clear()：すべてのバックアップを削除します。

ルール管理

• my_context_rule_list()：コンテキスト内のすべてのルールをリストします。
• my_context_rule_set()：ルールを作成または更新します。
• my_context_rule_remove()：ルールを削除します。

断片管理

• my_context_snippet_list()：コンテキスト内の断片をリストします。
• my_context_snippet_get()：特定の断片を取得します。
• my_context_snippet_set()：断片を作成または更新します。
• my_context_snippet_remove()：断片を削除します。

要約管理

• my_context_summary_list()：コンテキスト内の要約をリストします。
• my_context_summary_get()：特定の要約を取得します。
• my_context_summary_set()：要約を作成または更新します。
• my_context_summary_remove()：要約を削除します。

LLMとの連携

「me」コンテキスト

「me」は特殊なデフォルトのコンテキストで、常に利用可能です。すべての会話に適用されるグローバルなルール、断片、要約が含まれています。

コンテキストのロード

LLMは会話の開始時にコンテキストをロードする必要があります。これにより、「me」コンテキストからすべてのルール、断片、要約が取得されます。その後、LLMは返されたルールに従う必要があります。

追加のコンテキスト

「me」に加えて、追加のコンテキストを指定することで、他のコンテキストをロードすることができます。例えば：

• 「coding」コンテキスト：プログラミング関連の断片を含む。
• 「creative」コンテキスト：ライティングのヒントを含む。
• 「technical」コンテキスト：専門知識を含む。

これらは必要に応じて、デフォルトの「me」コンテキストと一緒に追加することができます。