@autodevjapan/godd-mcp-alpha 1.27.1 → 1.28.0

package/README.md

@@ -94,6 +94,7 @@ Available GoDD prompts (MCP tools) in Cursor IDE:
 | `e2e` | Browser-based E2E testing (execute & verify critical user flows) |
 | `map` | Project knowledge graph (visualize architecture & dependencies with Mermaid) |
 | `learn` | Save/recall project-specific patterns, conventions, and pitfalls |
+| `scratchpad` | Persistent conversation memory — save/recall/search/list/forget with BM25 vector search |
 | `diagram` | Auto-update architecture diagrams (maintain living Mermaid docs in sync with code) |
 | `slide` | Generate presentation slides from project docs (Marp Markdown format) |
 | `design` | Generate/update visual designs from codebase (Pencil.dev sync) |
@@ -108,6 +109,25 @@ Available GoDD prompts (MCP tools) in Cursor IDE:
 | `godd-a uninstall` | Remove MCP server from Cursor |
 | `godd-a serve` | Start MCP stdio server (auto-invoked by Cursor) |
 
+### Scratchpad (Persistent Memory)
+
+GoDD includes a scratchpad system for storing and retrieving conversation memories across sessions.
+
+```bash
+# Start Qdrant for vector search (optional — works without it via local JSON fallback)
+cd godd-mcp-alpha && docker compose up -d
+```
+
+| Action | Example | Description |
+|---|---|---|
+| `save` | `scratchpad save Auth flow uses JWT + refresh tokens` | Store a memory, returns a `mem::` address |
+| `recall` | `scratchpad recall mem::godd::abc123` | Retrieve full content by address |
+| `search` | `scratchpad search authentication` | BM25 search, returns top 5 matches |
+| `list` | `scratchpad list` | Show all saved memories |
+| `forget` | `scratchpad forget mem::godd::abc123` | Delete a memory |
+
+Without Docker/Qdrant, the scratchpad falls back to `.godd/scratchpad.json` with keyword-based search.
+
 ### Getting a License Key
 
 A license key is required to use GoDD MCP. Follow these steps:
@@ -250,6 +270,7 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
 | `e2e` | ブラウザベース E2E テスト（重要ユーザーフローの実行・検証） |
 | `map` | プロジェクトナレッジグラフ（Mermaid でアーキテクチャ・依存関係を可視化） |
 | `learn` | プロジェクト固有のパターン・慣例・落とし穴を保存/参照 |
+| `scratchpad` | 会話記憶の永続化 — BM25 ベクター検索で save/recall/search/list/forget |
 | `diagram` | アーキテクチャ図の自動更新（コードと同期した Mermaid ドキュメントを維持） |
 | `slide` | プロジェクトドキュメントからプレゼンスライドを生成（Marp Markdown 形式） |
 | `design` | コードベースからビジュアルデザインを生成/更新（Pencil.dev 同期） |
@@ -264,6 +285,25 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
 | `godd-a uninstall` | Cursor から MCP サーバーを削除 |
 | `godd-a serve` | MCP stdio サーバーを起動（Cursor が自動呼び出し） |
 
+### スクラッチパッド（永続メモリ）
+
+GoDD にはセッションをまたいで会話記憶を保存・検索できるスクラッチパッドシステムが組み込まれています。
+
+```bash
+# ベクター検索用に Qdrant を起動（任意 — なくてもローカル JSON フォールバックで動作）
+cd godd-mcp-alpha && docker compose up -d
+```
+
+| アクション | 例 | 説明 |
+|---|---|---|
+| `save` | `scratchpad save 認証フローは JWT + リフレッシュトークンを使用` | 記憶を保存し、`mem::` アドレスを返す |
+| `recall` | `scratchpad recall mem::godd::abc123` | アドレスで記憶の全文を取得 |
+| `search` | `scratchpad search 認証` | BM25 検索、上位 5 件を返す |
+| `list` | `scratchpad list` | 保存された記憶の一覧を表示 |
+| `forget` | `scratchpad forget mem::godd::abc123` | 記憶を削除 |
+
+Docker/Qdrant なしの場合は `.godd/scratchpad.json` にフォールバックし、キーワードベースの検索で動作します。
+
 ### ライセンスキーの取得
 
 GoDD MCP を利用するにはライセンスキーが必要です。以下の手順で取得できます。
@@ -406,6 +446,7 @@ GoDD MCP доставляет промпты **по требованию** —
 | `e2e` | E2E-тестирование в браузере (выполнение и проверка критических пользовательских потоков) |
 | `map` | Граф знаний проекта (визуализация архитектуры и зависимостей через Mermaid) |
 | `learn` | Сохранение/вызов специфичных для проекта паттернов, соглашений и подводных камней |
+| `scratchpad` | Постоянная память диалога — save/recall/search/list/forget с BM25 векторным поиском |
 | `diagram` | Автообновление архитектурных диаграмм (поддержка актуальных Mermaid-документов) |
 | `slide` | Генерация презентационных слайдов из документации проекта (формат Marp Markdown) |
 | `design` | Генерация/обновление визуального дизайна из кодовой базы (синхронизация с Pencil.dev) |
@@ -420,6 +461,25 @@ GoDD MCP доставляет промпты **по требованию** —
 | `godd-a uninstall` | Удалить MCP-сервер из Cursor |
 | `godd-a serve` | Запустить MCP stdio-сервер (автоматически вызывается Cursor) |
 
+### Скрэтчпад (постоянная память)
+
+GoDD включает систему скрэтчпада для сохранения и поиска воспоминаний между сессиями.
+
+```bash
+# Запустить Qdrant для векторного поиска (опционально — работает и без него через локальный JSON)
+cd godd-mcp-alpha && docker compose up -d
+```
+
+| Действие | Пример | Описание |
+|---|---|---|
+| `save` | `scratchpad save Авторизация использует JWT + refresh-токены` | Сохранить запись, возвращает адрес `mem::` |
+| `recall` | `scratchpad recall mem::godd::abc123` | Получить полное содержимое по адресу |
+| `search` | `scratchpad search авторизация` | BM25-поиск, возвращает топ-5 результатов |
+| `list` | `scratchpad list` | Показать все сохранённые записи |
+| `forget` | `scratchpad forget mem::godd::abc123` | Удалить запись |
+
+Без Docker/Qdrant скрэтчпад использует `.godd/scratchpad.json` с поиском по ключевым словам.
+
 ### Получение лицензионного ключа
 
 Для использования GoDD MCP необходим лицензионный ключ. Получите его следующим образом: