@autodevjapan/godd-mcp-alpha 1.31.0 → 1.32.1

package/README.md

@@ -63,10 +63,29 @@ GoDD MCP delivers prompts **on demand** — only the prompt you call is sent to
 
 | Approach | How it works | Token cost per call |
 |---|---|---|
-| **Cursor Rules** | All rules always in context | ~80,000 tokens × every chat |
-| **GoDD MCP** | Only the called prompt, when called | ~2,000–5,000 tokens per call |
+| **Plain Cursor (no GoDD)** | No structured prompts; agent uses more iterations | ~80,000+ tokens per task |
+| **GoDD MCP** | Optimized prompts delivered on demand | ~2,000–5,000 tokens per call |
 
-Use `/metrics` at any time during a session to see your actual token usage and estimated savings vs. the Cursor Rules baseline.
+Use `/metrics` at any time during a session to see your actual token usage and estimated savings. Savings are measured empirically via benchmarks comparing GoDD-guided vs. unguided Cursor sessions.
+
+### GoDD Token Killer (godd-tk)
+
+**Bundled CLI proxy for 60-90% additional token savings on command output.**
+
+godd-tk intercepts shell commands executed by AI agents and compresses their output before it reaches the LLM. It is automatically installed alongside GoDD MCP via `npm postinstall`.
+
+```
+AI Agent → Shell("git status") → godd-tk → compressed output → AI Agent
+```
+
+| Feature | Description |
+|---|---|
+| Output filtering | Strips ANSI codes, noise lines, and verbose formatting |
+| Smart truncation | Keeps essential information, truncates repetitive output |
+| Usage analytics | Tracks tokens saved per command with built-in SQLite |
+| Auto-install | Downloaded automatically on `npm install` |
+
+Run `godd-tk gain` to see cumulative token savings.
 
 ### GoDD Prompts
 
@@ -98,7 +117,7 @@ Available GoDD prompts (MCP tools) in Cursor IDE:
 | `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) |
-| `metrics` | Token efficiency report — show prompt tokens delivered this session vs. always-on Cursor Rules baseline |
+| `metrics` | Token efficiency report — show prompt tokens delivered this session vs. unguided Cursor baseline (benchmark-based) |
 
 ### CLI Commands
 
@@ -108,11 +127,14 @@ Available GoDD prompts (MCP tools) in Cursor IDE:
 | `godd-a init [--force] [--lang=LANG] [--auto]` | Generate project config.godd |
 | `godd-a uninstall` | Remove MCP server from Cursor |
 | `godd-a serve` | Start MCP stdio server (auto-invoked by Cursor) |
+| `godd-a --version` / `godd-a -v` | Show installed version |
 
 ### Scratchpad (Persistent Memory)
 
 GoDD includes a scratchpad system for storing and retrieving conversation memories across sessions.
 
+Docker Desktop is auto-started when GoDD MCP launches (if installed). For manual setup:
+
 ```bash
 # Start Qdrant for vector search (optional — works without it via local JSON fallback)
 cd godd-mcp-alpha && docker compose up -d
@@ -239,10 +261,29 @@ GoDD MCP はプロンプトを**オンデマンドで配信**します。呼び
 
 | 方式 | 仕組み | 1回あたりのトークンコスト |
 |---|---|---|
-| **Cursor Rules** | 全ルールを常時コンテキストに含む | ~80,000 tokens × 毎会話 |
-| **GoDD MCP** | 呼び出したプロンプトだけを必要なときに配信 | ~2,000〜5,000 tokens / 呼び出し |
+| **素の Cursor（GoDD なし）** | 構造化プロンプトなし、エージェントの試行回数が増加 | ~80,000+ tokens / タスク |
+| **GoDD MCP** | 最適化されたプロンプトをオンデマンド配信 | ~2,000〜5,000 tokens / 呼び出し |
+
+セッション中いつでも `/metrics` を実行すると、実際のトークン使用量と節約推定値を確認できます。節約効果は GoDD 使用時と未使用時の実測ベンチマークで計測されます。
+
+### GoDD Token Killer (godd-tk)
+
+**コマンド出力を圧縮し、さらに 60-90% のトークン削減を実現するバンドル CLI プロキシ。**
+
+godd-tk は AI エージェントが実行するシェルコマンドの出力をインターセプトし、LLM に渡す前に圧縮します。`npm install` 時に自動でインストールされます。
+
+```
+AI エージェント → Shell("git status") → godd-tk → 圧縮済み出力 → AI エージェント
+```
+
+| 機能 | 説明 |
+|---|---|
+| 出力フィルタリング | ANSI コード、ノイズ行、冗長な書式を除去 |
+| スマート切り詰め | 重要な情報を維持し、反復的な出力を切り詰め |
+| 使用量分析 | コマンドごとの節約トークン数を SQLite で追跡 |
+| 自動インストール | `npm install` 時に自動ダウンロード |
 
-セッション中いつでも `/metrics` を実行すると、実際のトークン使用量と Cursor Rules 方式との節約推定値を確認できます。
+`godd-tk gain` で累計トークン節約量を確認できます。
 
 ### GoDD プロンプト一覧
 
@@ -274,7 +315,7 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
 | `diagram` | アーキテクチャ図の自動更新（コードと同期した Mermaid ドキュメントを維持） |
 | `slide` | プロジェクトドキュメントからプレゼンスライドを生成（Marp Markdown 形式） |
 | `design` | コードベースからビジュアルデザインを生成/更新（Pencil.dev 同期） |
-| `metrics` | トークン効率レポート — このセッションの配信トークン数と Cursor Rules 常時読み込み方式との比較 |
+| `metrics` | トークン効率レポート — このセッションの配信トークン数と素の Cursor との比較（実測ベンチマークベース） |
 
 ### CLI コマンド
 
@@ -284,11 +325,14 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
 | `godd-a init [--force] [--lang=LANG] [--auto]` | プロジェクトの config.godd を生成 |
 | `godd-a uninstall` | Cursor から MCP サーバーを削除 |
 | `godd-a serve` | MCP stdio サーバーを起動（Cursor が自動呼び出し） |
+| `godd-a --version` / `godd-a -v` | インストール済みバージョンを表示 |
 
 ### スクラッチパッド（永続メモリ）
 
 GoDD にはセッションをまたいで会話記憶を保存・検索できるスクラッチパッドシステムが組み込まれています。
 
+GoDD MCP 起動時に Docker Desktop は自動的に起動されます（インストール済みの場合）。手動セットアップ:
+
 ```bash
 # ベクター検索用に Qdrant を起動（任意 — なくてもローカル JSON フォールバックで動作）
 cd godd-mcp-alpha && docker compose up -d
@@ -415,10 +459,29 @@ GoDD MCP доставляет промпты **по требованию** —
 
 | Подход | Принцип работы | Стоимость токенов за вызов |
 |---|---|---|
-| **Cursor Rules** | Все правила всегда в контексте | ~80 000 токенов × каждый чат |
-| **GoDD MCP** | Только нужный промпт, только когда нужен | ~2 000–5 000 токенов за вызов |
+| **Cursor без GoDD** | Нет структурированных промптов; агент тратит больше итераций | ~80 000+ токенов на задачу |
+| **GoDD MCP** | Оптимизированные промпты по требованию | ~2 000–5 000 токенов за вызов |
+
+В любой момент сессии введите `/metrics`, чтобы увидеть фактическое использование токенов и расчётную экономию. Экономия измеряется эмпирически через бенчмарки, сравнивающие сессии с GoDD и без него.
+
+### GoDD Token Killer (godd-tk)
+
+**Встроенный CLI-прокси для дополнительной экономии 60-90% токенов на вывод команд.**
 
-В любой момент сессии введите `/metrics`, чтобы увидеть фактическое использование токенов и расчётную экономию по сравнению с подходом Cursor Rules.
+godd-tk перехватывает команды оболочки, выполняемые AI-агентами, и сжимает их вывод перед отправкой в LLM. Автоматически устанавливается вместе с GoDD MCP через `npm postinstall`.
+
+```
+AI-агент → Shell("git status") → godd-tk → сжатый вывод → AI-агент
+```
+
+| Функция | Описание |
+|---|---|
+| Фильтрация вывода | Удаление ANSI-кодов, шумовых строк и избыточного форматирования |
+| Умная обрезка | Сохранение существенной информации, обрезка повторяющегося вывода |
+| Аналитика использования | Отслеживание сэкономленных токенов по командам через SQLite |
+| Автоустановка | Скачивается автоматически при `npm install` |
+
+Запустите `godd-tk gain` для просмотра накопленной экономии токенов.
 
 ### Список промптов GoDD
 
@@ -450,7 +513,7 @@ GoDD MCP доставляет промпты **по требованию** —
 | `diagram` | Автообновление архитектурных диаграмм (поддержка актуальных Mermaid-документов) |
 | `slide` | Генерация презентационных слайдов из документации проекта (формат Marp Markdown) |
 | `design` | Генерация/обновление визуального дизайна из кодовой базы (синхронизация с Pencil.dev) |
-| `metrics` | Отчёт об эффективности токенов — токены этой сессии vs. базовый уровень Cursor Rules |
+| `metrics` | Отчёт об эффективности токенов — токены этой сессии vs. базовый уровень Cursor без GoDD (на основе бенчмарков) |
 
 ### Команды CLI
 
@@ -460,11 +523,14 @@ GoDD MCP доставляет промпты **по требованию** —
 | `godd-a init [--force] [--lang=LANG] [--auto]` | Сгенерировать config.godd для проекта |
 | `godd-a uninstall` | Удалить MCP-сервер из Cursor |
 | `godd-a serve` | Запустить MCP stdio-сервер (автоматически вызывается Cursor) |
+| `godd-a --version` / `godd-a -v` | Показать установленную версию |
 
 ### Скрэтчпад (постоянная память)
 
 GoDD включает систему скрэтчпада для сохранения и поиска воспоминаний между сессиями.
 
+Docker Desktop автоматически запускается при старте GoDD MCP (если установлен). Для ручной настройки:
+
 ```bash
 # Запустить Qdrant для векторного поиска (опционально — работает и без него через локальный JSON)
 cd godd-mcp-alpha && docker compose up -d