@autodevjapan/godd-mcp-alpha 2.5.0 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,26 +10,29 @@
10
10
 
11
11
  ## English
12
12
 
13
- AI prompt delivery system for MCP-compatible clients (Cursor IDE, Claude Code CLI, Codex, Kimi CLI, and Google Antigravity IDE). Delivers project-optimized prompts, mindsets, and agent definitions via MCP (Model Context Protocol). The server is client-agnostic — the same `serve` command works with any MCP host. Cursor, Claude Code, Codex, Kimi CLI, and Antigravity are officially supported.
13
+ **GoDD delivers battle-tested development prompts, mindsets, and agent workflows straight into your AI coding client** — Cursor IDE, Claude Code CLI, Codex, Kimi CLI, and Google Antigravity IDE — over the Model Context Protocol (MCP).
14
14
 
15
- The npm package remains the primary distribution entry point. `godd-a serve` runs the Rust-native MCP runtime; Node.js is retained for npm lifecycle tasks, native binary installation, and compatibility CLI commands.
16
- The `config`, `questions`, and `scratchpad` tools invoke the existing Node.js handler only for the duration of that call to preserve diagnostic and storage compatibility; the MCP server itself remains Rust-native.
15
+ ### Why use GoDD
17
16
 
18
- For a self-hosted provider gateway, set `GODD_PROVIDER_GATEWAY_URL` and run
19
- `godd-a gateway doctor`. The Rust runtime validates the URL, probes
20
- `/health/readiness` with a three-second timeout, and reports the
21
- `direct-registry` fallback without printing provider credentials. Use
22
- `--no-probe` to validate configuration without network access.
17
+ - **Ship higher-quality code faster.** Every prompt is built on seven proven xDD methodologies (Spec / Acceptance-Test / Test / Domain / Neo-Model / Docs / Issue-Driven Development), so the AI plans, tests, and documents like a senior engineer instead of guessing.
18
+ - **One command per task.** Call `/dev`, `/review`, `/ship`, and more — the AI runs the full plan → implement → test → quality → docs cycle for you.
19
+ - **Fewer tokens, lower cost.** Prompts are delivered **on demand** — only the one you invoke enters the AI's context. That is typically ~2,000–5,000 tokens per call versus ~80,000+ for always-on rule files.
20
+ - **Works with the clients you already use.** The same server registers with every supported client; project settings are auto-detected.
21
+ - **Stays in sync with your stack.** `godd-a init` generates a project profile so delivered prompts match your language, framework, and tooling.
23
22
 
24
- Plan interruptions, resumptions, and deviations can be recorded by the Rust runtime with
25
- `godd-a plan audit record` and verified before resume with
26
- `godd-a plan audit verify`. Set `GODD_PLAN_AUDIT_KEY` to at least 32 bytes.
27
- Free-form notes are not accepted, and the key is never written.
23
+ ### Requirements
24
+
25
+ - **A GoDD license key** (required — see [Getting a license key](#getting-a-license-key))
26
+ - Node.js 22+
27
+ - An MCP-compatible client: Cursor IDE, Claude Code CLI, Codex, Kimi CLI, or Antigravity IDE
28
28
 
29
- An experimental Rust domain contract can validate explicit `provider:model` routes for
30
- OpenAI-compatible providers. It does not start an HTTP proxy, read secret values, issue
31
- virtual keys, or change the MCP runtime. See
32
- `documents/spec/multi-provider-gateway.md` in the source repository.
29
+ ### Getting a license key
30
+
31
+ A valid license key is required to use GoDD MCP.
32
+
33
+ 1. Review plans on the [GoDD official site](https://www.getgodd.dev/pricing)
34
+ 2. [Create an account](https://www.getgodd.dev/godd-admin/register) and choose a subscription
35
+ 3. Issue a license key from your [dashboard](https://www.getgodd.dev/godd-admin/dashboard)
33
36
 
34
37
  ### Installation
35
38
 
@@ -37,154 +40,30 @@ virtual keys, or change the MCP runtime. See
37
40
  npm install -g @autodevjapan/godd-mcp-alpha
38
41
  ```
39
42
 
40
- ### Setup (Recommended)
43
+ ### Setup
41
44
 
42
45
  ```bash
43
- # Auto-detect installed MCP clients and register the server with each of them
46
+ # Auto-detect installed MCP clients and register with each of them
44
47
  godd-a install --license-key=YOUR_LICENSE_KEY
45
48
 
46
- # Or target a specific client: cursor / claude-code / codex / kimi / antigravity / all
49
+ # Or target one client: cursor / claude-code / codex / kimi / antigravity / all
47
50
  godd-a install --client=cursor --license-key=YOUR_LICENSE_KEY
48
51
 
49
- # Auto-generate project config.godd (interactive)
52
+ # Generate a project config (interactive; add --auto for CI/CD)
50
53
  godd-a init
51
-
52
- # Or fully automatic mode (for CI/CD)
53
- godd-a init --auto
54
- ```
55
-
56
- > **Use `godd-a install`.** Manual editing of mcp.json is not recommended.
57
- > `godd-a install` correctly configures the startup command, PATH, and license key.
58
-
59
- ### Manual mcp.json Configuration
60
-
61
- If `godd-a install` is unavailable, you can edit the client's config file directly — `~/.cursor/mcp.json` for Cursor, `~/.gemini/antigravity/mcp_config.json` for Antigravity (both use the well-known `{"mcpServers": {...}}` format). When no known client is detected, `godd-a install` prints this same snippet for manual setup.
62
- **The `serve` argument is required.** Without it, the installer mode starts and MCP communication breaks.
63
-
64
- ```json
65
- {
66
- "mcpServers": {
67
- "godd-a": {
68
- "command": "npx",
69
- "args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
70
- "env": {
71
- "GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
72
- }
73
- }
74
- }
75
- }
76
- ```
77
-
78
- ### Claude Code CLI Setup
79
-
80
- Register the server into Claude Code CLI with the `--client=claude-code` flag:
81
-
82
- ```bash
83
- godd-a install --client=claude-code --license-key=YOUR_LICENSE_KEY
84
- ```
85
-
86
- This delegates registration to `claude mcp add-json` at **user scope** (`~/.claude.json`), so it merges safely alongside your other MCP servers and is re-runnable (an existing entry is refreshed). When the `claude` CLI is not on your PATH, the installer prints the exact command to run by hand instead.
87
-
88
- Without `--client`, `godd-a install` auto-detects locally installed clients and registers with all of them (if none is detected, it prints a generic `mcpServers` snippet for manual setup). The startup command, args, and env are identical across clients, and the license device binding is per-device.
89
-
90
- <details>
91
- <summary>Manual registration (if you prefer not to use <code>godd-a install</code>)</summary>
92
-
93
- ```bash
94
- claude mcp add godd-a \
95
- --env GODD_LICENSE_KEY=GODD-XXXX-XXXX \
96
- -- npx -y @autodevjapan/godd-mcp-alpha@latest serve
97
- ```
98
-
99
- Or add a project-root `.mcp.json` with the same `mcpServers` structure shown above (the `serve` argument is required).
100
- </details>
101
-
102
- ### Codex Setup
103
-
104
- Register through Codex's official MCP CLI. Codex CLI, the IDE extension, and the app share this MCP configuration:
105
-
106
- ```bash
107
- godd-a install --client=codex --license-key=YOUR_LICENSE_KEY
108
- ```
109
-
110
- Verify with `codex mcp list` or `/mcp`. Remove it with `godd-a uninstall --client=codex`.
111
-
112
- ### Kimi CLI Setup
113
-
114
- Register through Kimi CLI's official MCP command:
115
-
116
- ```bash
117
- godd-a install --client=kimi --license-key=YOUR_LICENSE_KEY
118
- ```
119
-
120
- This delegates registration to `kimi mcp add --transport stdio` (environment variables are passed with `-e KEY=VALUE`). When the `kimi` CLI is not on your PATH, the installer prints the exact command to run by hand. Verify with `/mcp` inside a Kimi CLI session. Remove it with `godd-a uninstall --client=kimi`.
121
-
122
- ### Antigravity Setup
123
-
124
- Register into Google Antigravity IDE's MCP config file:
125
-
126
- ```bash
127
- godd-a install --client=antigravity --license-key=YOUR_LICENSE_KEY
128
54
  ```
129
55
 
130
- This merges the well-known `{"mcpServers": {...}}` entry into `~/.gemini/antigravity/mcp_config.json` without touching other server entries. Remove it with `godd-a uninstall --client=antigravity`.
56
+ > Use `godd-a install` — it configures the startup command, PATH, and license key for you. Restart your client afterward and the GoDD tools appear automatically.
131
57
 
132
58
  ### Usage
133
59
 
134
- After installation, restart your MCP client (Cursor IDE, Claude Code CLI, Codex, Kimi CLI, or Antigravity) and the GoDD MCP α server will start automatically. There are three ways to invoke GoDD tools:
135
-
136
- **Option 1 — Your client's native UI:** Use whatever your client surfaces for MCP prompts/tools — for example, in Cursor type `/` in the chat input and pick a GoDD prompt from the dropdown (`/dev`, `/review`), or in Agent mode ask in plain language ("run dev", "do a review") and the AI calls the matching tool.
137
-
138
- **Option 2 — Native slash commands (generated at install):** `godd-a install` writes `godd-a-<tool>.md` command files into clients that support user-defined commands — Cursor (`~/.cursor/commands/`), Claude Code (`~/.claude/commands/`), Codex (`$CODEX_HOME/prompts` or `~/.codex/prompts/`, loaded at session start), and Antigravity (`~/.gemini/antigravity/workflows/` — community-sourced location, not yet officially confirmed). Invoke them as `/godd-a-dev`, `/godd-a-review`, etc. — client command names cannot contain `/` or `:`, hence the dash form. Kimi CLI has no custom slash-command support, so no files are generated for it.
139
-
140
- **Option 3 — Text dispatch via the `run` tool:** Type `/godd-a/dev <args>` as plain text in the chat. The always-loaded dispatch rules (the AGENTS.md GoDD block and `.cursor/rules/godd-stack.mdc`, regenerated by the `config` tool (via chat) or `godd-a init`) instruct the AI to pass the full text to the GoDD MCP `run` tool, which parses every notation — `/godd-a/<tool>`, `godd-a/<tool>`, `/godd-a:<tool>`, `/godd-a_<tool>`, `mcp__godd-a__<tool>`, or a bare `/<tool>` — and runs the matching tool.
141
-
142
- ### Token Efficiency
60
+ Invoke GoDD in whichever way your client supports:
143
61
 
144
- GoDD MCP delivers prompts **on demand** — only the prompt you call is sent to the AI's context. This is fundamentally different from Cursor Rules, which loads all rules into every conversation from the start.
62
+ - **Native UI** — type `/` in the chat and pick a GoDD prompt (e.g. `/dev`, `/review`), or in Agent mode just ask ("run dev", "do a review").
63
+ - **Slash commands** — `godd-a install` writes `/godd-a-<tool>` command files for clients that support them (Cursor, Claude Code, Codex, Antigravity).
64
+ - **Text dispatch** — type `/godd-a/dev <args>` as plain text; the AI routes it to the matching tool.
145
65
 
146
- | Approach | How it works | Token cost per call |
147
- |---|---|---|
148
- | **Plain Cursor (no GoDD)** | No structured prompts; agent uses more iterations | ~80,000+ tokens per task |
149
- | **GoDD MCP** | Optimized prompts delivered on demand | ~2,000–5,000 tokens per call |
150
-
151
- 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.
152
-
153
- The optional `quality_evidence` JSON argument also produces a reproducible
154
- assessment of excessive output, execution completion, and design integrity.
155
- Missing evidence is reported as `INCONCLUSIVE`, not guessed as a failure.
156
- The optional `learning_evidence` accepts numeric and boolean aggregates only,
157
- and deterministically assesses learning outcomes and claim grounding. Empty or
158
- incomplete evidence is `INCONCLUSIVE`; do not include raw text or secrets.
159
-
160
- ### GoDD Token Killer (godd-tk)
161
-
162
- **Bundled CLI proxy for additional token savings on command output — measured 88.1% weighted-average est. reduction on the bundled benchmark (0–94% by command shape).**
163
-
164
- 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`.
165
-
166
- ```
167
- AI Agent → Shell("git status") → godd-tk → compressed output → AI Agent
168
- ```
169
-
170
- | Feature | Description |
171
- |---|---|
172
- | Output filtering | Strips ANSI codes, noise lines, and verbose formatting |
173
- | Statistical compression | Typed compressors (log / json / diff / test-report / generic-text) fold repetitive output while keeping errors and failure details intact |
174
- | Reversible compression (CCR) | Raw output is stored locally in full before compression — recover it anytime with `godd-tk show <id>` |
175
- | Usage analytics | Tracks tokens saved per command with built-in SQLite |
176
- | Auto-install | Downloaded automatically on `npm install` |
177
-
178
- Run `godd-tk gain` to see cumulative token savings.
179
-
180
- Automatic compression hooks are currently configured only for Cursor. Other MCP
181
- clients remain usable without compression and can opt in with
182
- `godd-tk exec -- <command>`. Run `godd-a compatibility` for the implementation-backed
183
- matrix; real-client OS checks are shown as `unverified` until smoke-test evidence exists.
184
-
185
- ### GoDD Prompts
186
-
187
- Available GoDD prompts (MCP tools):
66
+ ### GoDD prompts
188
67
 
189
68
  | Prompt | Description |
190
69
  |---|---|
@@ -205,134 +84,61 @@ Available GoDD prompts (MCP tools):
205
84
  | `release` | Generate release notes (SemVer-compliant) |
206
85
  | `github` | GitHub configuration (repository/branch protection etc.) |
207
86
  | `config` | Generate/repair config.godd (auto-detect stack + validation) |
208
- | `questions` | Manage question list (質問リスト.md) interactively |
87
+ | `questions` | Manage the question list interactively |
209
88
  | `e2e` | Browser-based E2E testing (execute & verify critical user flows) |
210
89
  | `map` | Project knowledge graph (visualize architecture & dependencies with Mermaid) |
211
90
  | `learn` | Save/recall project-specific patterns, conventions, and pitfalls |
212
- | `scratchpad` | Persistent conversation memory — save/recall/search/list/forget with BM25 vector search |
213
- | `diagram` | Auto-update architecture diagrams (maintain living Mermaid docs in sync with code) |
214
- | `slide` | Generate presentation slides from project docs (Marp Markdown format) |
215
- | `design` | Generate/update visual designs from codebase (Pencil.dev sync) |
216
- | `metrics` | Token efficiency report — show prompt tokens delivered this session vs. unguided Cursor baseline (benchmark-based) |
91
+ | `scratchpad` | Persistent conversation memory (save/recall/search/list/forget) |
92
+ | `diagram` | Auto-update architecture diagrams (living Mermaid docs in sync with code) |
93
+ | `slide` | Generate presentation slides from project docs (Marp Markdown) |
94
+ | `design` | Generate/update visual designs from the codebase |
95
+ | `metrics` | Token efficiency report for the current session |
217
96
 
218
- ### CLI Commands
97
+ ### CLI commands
219
98
 
220
99
  | Command | Description |
221
100
  |---|---|
222
- | `godd-a install [--license-key=KEY] [--client=...]` | Register with MCP clients (`cursor` / `claude-code` / `codex` / `kimi` / `antigravity` / `all`; auto-detects installed clients when omitted) |
223
- | `godd-a init [--force] [--lang=LANG] [--auto]` | Generate project config.godd |
224
- | `godd-a uninstall [--client=...]` | Remove from MCP clients (same `--client` resolution as install) |
225
- | `godd-a compatibility` | Print the implementation-backed godd-tk client compatibility matrix |
226
- | `godd-a codec-capability verify [...]` | Verify codec manifest, artifact, runtime probe, and known answers in packaged Rust |
227
- | `godd-a plan audit <record\|verify> [...]` | Record or verify tamper-evident plan interruption/resume/deviation evidence |
228
- | `godd-a research <action> [options]` | Persist/resume an anonymized research checkpoint in Rust (no search or LLM calls) |
229
- | `godd-a serve` | Start MCP stdio server (auto-invoked by the client) |
230
- | `godd-a --version` / `godd-a -v` | Show installed version |
231
-
232
- ### Scratchpad (Persistent Memory)
233
-
234
- GoDD includes a scratchpad system for storing and retrieving conversation memories across sessions.
235
-
236
- Docker Desktop is auto-started when GoDD MCP launches (if installed). For manual setup:
237
-
238
- ```bash
239
- # Start Qdrant for vector search (optional — works without it via local JSON fallback)
240
- cd godd-mcp-alpha && docker compose up -d
241
- ```
242
-
243
- | Action | Example | Description |
244
- |---|---|---|
245
- | `save` | `scratchpad save Auth flow uses JWT + refresh tokens` | Store a memory, returns a `mem::` address |
246
- | `recall` | `scratchpad recall mem::godd::abc123` | Retrieve full content by address |
247
- | `search` | `scratchpad search authentication` | BM25 search, returns top 5 matches |
248
- | `list` | `scratchpad list` | Show all saved memories |
249
- | `forget` | `scratchpad forget mem::godd::abc123` | Delete a memory |
250
-
251
- Without Docker/Qdrant, the scratchpad falls back to `.godd/scratchpad.json` with keyword-based search.
252
-
253
- ### Getting a License Key
254
-
255
- A license key is required to use GoDD MCP. Follow these steps:
256
-
257
- 1. Check plans at the [GoDD official site](https://www.getgodd.dev/pricing)
258
- 2. [Register an account](https://www.getgodd.dev/godd-admin/register) and purchase a subscription
259
- 3. Issue a license key from your [dashboard](https://www.getgodd.dev/godd-admin/dashboard)
260
-
261
- Set the issued license key with `godd-a install --license-key=YOUR_KEY`.
262
-
263
- ### Requirements
264
-
265
- - Node.js 22+
266
- - An MCP-compatible client — Cursor IDE, Claude Code CLI, Codex, Kimi CLI, or Antigravity IDE
267
- - GoDD license key (get one at [official site](https://www.getgodd.dev/pricing))
101
+ | `godd-a install [--license-key=KEY] [--client=...]` | Register with MCP clients (auto-detects installed clients when `--client` is omitted) |
102
+ | `godd-a init [--force] [--lang=LANG] [--auto]` | Generate the project config |
103
+ | `godd-a uninstall [--client=...]` | Remove from MCP clients |
104
+ | `godd-a version` (or `--version` / `-v`) | Show the installed version and check for updates |
105
+ | `godd-a serve` | Start the MCP stdio server (auto-invoked by the client) |
268
106
 
269
107
  ### Troubleshooting
270
108
 
271
- #### "0 tools available" is shown
272
-
273
- If Cursor's MCP log shows errors like:
274
-
275
- ```
276
- Unexpected end of JSON input
277
- Unexpected token 'G', "GoDD MCP α"... is not valid JSON
278
- ```
279
-
280
- **Cause**: `mcp.json` `args` does not include `"serve"`. Without it, the installer mode starts (human-readable text output) and breaks the JSON-RPC communication Cursor expects.
281
-
282
- **Fix**:
283
-
284
- ```bash
285
- # Reinstall to regenerate mcp.json correctly
286
- npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
287
- ```
288
-
289
- Then restart Cursor.
290
-
291
- #### License key is bound to another device
292
-
293
- GoDD license keys are bound to a device. To use on a different device, issue a new license key.
294
-
295
- ```bash
296
- godd-a install --license-key=NEW_LICENSE_KEY
297
- ```
109
+ **"0 tools available" in your client** — this means the server was started without the required `serve` argument. Re-run `godd-a install` to regenerate the client config correctly, then restart the client.
298
110
 
299
111
  ### License
300
112
 
301
- Proprietary — A GoDD license key is required. Purchase at the [official site](https://www.getgodd.dev/pricing).
113
+ Proprietary. Use requires a valid GoDD license key. See the [official site](https://www.getgodd.dev/) for terms and support.
302
114
 
303
115
  ---
304
116
 
305
- ### Version 2 migration and rollback
117
+ ## 日本語
118
+
119
+ **GoDD は、実戦で磨かれた開発プロンプト・マインドセット・エージェントワークフローを、お使いの AI コーディングクライアントに直接届けます** — Cursor IDE / Claude Code CLI / Codex / Kimi CLI / Google Antigravity IDE に、MCP(Model Context Protocol)経由で配信します。
306
120
 
307
- Version 2 keeps the package name, `npx`/global installation, `godd-a` binary, MCP key,
308
- stdio transport, tools, config, and persisted-state formats. The Rust runtime is now executed
309
- directly from the npm package. All four supported native assets are integrity-checked against a
310
- committed digest/size manifest; installation never requires GitHub authentication, `gh`, or an
311
- additional runtime download. Missing, tampered, unsupported, or version-mismatched assets fail
312
- closed without a Node MCP fallback. Linux x64 uses a static musl binary with no glibc runtime
313
- dependency; MCP smoke is verified on Debian Bookworm and Alpine.
121
+ ### GoDD を使うメリット
314
122
 
315
- Upgrade with `npm install -g @autodevjapan/godd-mcp-alpha@2.0.0`. Existing MCP configuration
316
- does not change. Roll back explicitly with
317
- `npm install -g @autodevjapan/godd-mcp-alpha@1.46.3`. `godd-tk` is a separate optional
318
- capability; opt in with `GODD_INSTALL_GODD_TK=1`.
123
+ - **より高品質なコードを、より速く。** すべてのプロンプトは実証済みの 7 つの xDD 手法(Spec / 受入テスト / テスト / ドメイン / Neo-Model / ドキュメント / Issue 駆動開発)に基づいており、AI が推測ではなくシニアエンジニアのように計画・テスト・文書化します。
124
+ - **1 タスク = 1 コマンド。** `/dev` `/review` `/ship` などを呼ぶだけで、計画 → 実装 → テスト → 品質 → ドキュメントの一連のサイクルを AI が実行します。
125
+ - **トークン削減でコストも低減。** プロンプトは**オンデマンド配信** — 呼び出したものだけが AI のコンテキストに入ります。常時読み込み型のルールファイルが 1 タスク ~80,000 トークン以上かかるのに対し、GoDD は 1 呼び出しあたり ~2,000〜5,000 トークン程度です。
126
+ - **今お使いのクライアントでそのまま。** 同じサーバーが対応クライアントすべてに登録でき、プロジェクト設定は自動検出されます。
127
+ - **スタックに追従。** `godd-a init` がプロジェクトプロファイルを生成し、配信されるプロンプトが言語・フレームワーク・ツールに合わせて最適化されます。
319
128
 
320
- ## 日本語
129
+ ### 動作要件
321
130
 
322
- MCP 対応クライアント(Cursor IDE / Claude Code CLI / Codex / Kimi CLI / Antigravity IDE)向けの AI プロンプト配信システム。MCP (Model Context Protocol) を通じて、プロジェクトの技術スタックに最適化されたプロンプト・マインドセット・エージェント定義を提供します。サーバー本体はクライアント非依存で、Cursor、Claude Code、Codex、Kimi CLI、Antigravity を正式サポートします。
131
+ - **GoDD ライセンスキー**(必須 — [ライセンスキーの取得](#ライセンスキーの取得)を参照)
132
+ - Node.js 22 以上
133
+ - MCP 対応クライアント: Cursor IDE / Claude Code CLI / Codex / Kimi CLI / Antigravity IDE のいずれか
323
134
 
324
- npmパッケージを主要配布入口として維持し、`godd-a serve`はRustネイティブMCP実行本体を起動します。Node.jsはnpmライフサイクル、ネイティブバイナリ導入、互換CLIに限定して使用します。
325
- `config`、`questions`、`scratchpad`は診断・保存形式の互換性を保つため、呼び出し中だけ既存Node.jsハンドラを実行します。MCPサーバー本体はRustのままです。
135
+ ### ライセンスキーの取得
326
136
 
327
- 計画の中断・再開・逸脱は Rust 実装の `godd-a plan audit record` で記録し、
328
- 再開前に `godd-a plan audit verify` で検証できます。32 bytes 以上の
329
- `GODD_PLAN_AUDIT_KEY` が必要です。自由記述は受け付けず、鍵は監査ログへ
330
- 出力されません。
137
+ GoDD MCP の利用には有効なライセンスキーが必要です。
331
138
 
332
- 実験的なRust domain contractとして、OpenAI互換providerの明示的な
333
- `provider:model` routeを検証できます。HTTP proxyの起動、秘密値の読取、仮想キー発行、
334
- 既存MCP runtimeの変更は行いません。詳細はソースリポジトリの
335
- `documents/spec/multi-provider-gateway.md` を参照してください。
139
+ 1. [GoDD 公式サイト](https://www.getgodd.dev/pricing)でプランを確認
140
+ 2. [アカウント登録](https://www.getgodd.dev/godd-admin/register)してサブスクリプションを選択
141
+ 3. [ダッシュボード](https://www.getgodd.dev/godd-admin/dashboard)からライセンスキーを発行
336
142
 
337
143
  ### インストール
338
144
 
@@ -340,155 +146,35 @@ npmパッケージを主要配布入口として維持し、`godd-a serve`はRus
340
146
  npm install -g @autodevjapan/godd-mcp-alpha
341
147
  ```
342
148
 
343
- ### セットアップ(推奨)
149
+ ### セットアップ
344
150
 
345
151
  ```bash
346
- # インストール済みの MCP クライアントを自動検出し、検出された全てに登録
152
+ # インストール済みの MCP クライアントを自動検出し、全てに登録
347
153
  godd-a install --license-key=YOUR_LICENSE_KEY
348
154
 
349
- # 特定のクライアントを指定する場合: cursor / claude-code / codex / kimi / antigravity / all
155
+ # 特定のクライアントを指定: cursor / claude-code / codex / kimi / antigravity / all
350
156
  godd-a install --client=cursor --license-key=YOUR_LICENSE_KEY
351
157
 
352
- # プロジェクトの config.godd を自動生成(インタラクティブ)
158
+ # プロジェクト設定を生成(インタラクティブ。CI/CD 用は --auto)
353
159
  godd-a init
354
-
355
- # または完全自動モード(CI/CD 環境向け)
356
- godd-a init --auto
357
- ```
358
-
359
- > **`godd-a install` を使ってください。** mcp.json の手動編集は非推奨です。
360
- > `godd-a install` は起動コマンド・PATH・ライセンスキーを正しく設定します。
361
-
362
- ### mcp.json を手動で設定する場合
363
-
364
- `godd-a install` が使えない環境では、クライアントの設定ファイルを直接編集できます(Cursor は `~/.cursor/mcp.json`、Antigravity は `~/.gemini/antigravity/mcp_config.json`。いずれも well-known な `{"mcpServers": {...}}` 形式)。既知のクライアントが1つも検出されない場合、`godd-a install` は手動設定用にこのスニペットを表示します。
365
- **`serve` 引数は必須です。** 省略するとインストーラーモードで起動し、MCP 通信が破綻します。
366
-
367
- ```json
368
- {
369
- "mcpServers": {
370
- "godd-a": {
371
- "command": "npx",
372
- "args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
373
- "env": {
374
- "GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
375
- }
376
- }
377
- }
378
- }
379
- ```
380
-
381
- ### Claude Code CLI でのセットアップ
382
-
383
- 次のコマンドで Claude Code CLI の user scope に登録します。既存設定とのマージは `claude` CLI に委譲されます。
384
-
385
- ```bash
386
- godd-a install --client=claude-code --license-key=YOUR_LICENSE_KEY
387
160
  ```
388
161
 
389
- `--client` を省略すると、インストール済みの既知クライアントが自動検出され、見つかった全てに登録されます(1つも検出されない場合は手動設定用の `mcpServers` スニペットを表示)。起動コマンド・引数・環境変数は全クライアントで同一です。
390
-
391
- 手動登録する場合:
392
-
393
- ```bash
394
- claude mcp add godd-a \
395
- --env GODD_LICENSE_KEY=GODD-XXXX-XXXX \
396
- -- npx -y @autodevjapan/godd-mcp-alpha@latest serve
397
- ```
398
-
399
- 削除は `godd-a uninstall --client=claude-code` を使用します。
400
-
401
- ### Codex でのセットアップ
402
-
403
- Codex 公式 CLI を通して登録します。Codex CLI、IDE extension、app はこの MCP 設定を共有します。
404
-
405
- ```bash
406
- godd-a install --client=codex --license-key=YOUR_LICENSE_KEY
407
- ```
408
-
409
- `codex mcp list` または `/mcp` で確認し、削除は `godd-a uninstall --client=codex` を使用します。
410
-
411
- ### Kimi CLI でのセットアップ
412
-
413
- Kimi CLI 公式の MCP コマンドを通して登録します。
414
-
415
- ```bash
416
- godd-a install --client=kimi --license-key=YOUR_LICENSE_KEY
417
- ```
418
-
419
- 登録は `kimi mcp add --transport stdio` に委譲されます(環境変数は `-e KEY=VALUE` で付与)。`kimi` CLI が PATH にない場合は、手動実行用のコマンドを表示します。Kimi CLI セッション内の `/mcp` で接続を確認し、削除は `godd-a uninstall --client=kimi` を使用します。
420
-
421
- ### Antigravity でのセットアップ
422
-
423
- Google Antigravity IDE の MCP 設定ファイルに登録します。
424
-
425
- ```bash
426
- godd-a install --client=antigravity --license-key=YOUR_LICENSE_KEY
427
- ```
428
-
429
- `~/.gemini/antigravity/mcp_config.json` に well-known な `{"mcpServers": {...}}` エントリをマージします(他のサーバー設定は保持)。削除は `godd-a uninstall --client=antigravity` を使用します。
162
+ > `godd-a install` を使ってください — 起動コマンド・PATH・ライセンスキーを自動で設定します。実行後にクライアントを再起動すると、GoDD ツールが自動的に表示されます。
430
163
 
431
164
  ### 使い方
432
165
 
433
- インストール後、MCP クライアント(Cursor IDE、Claude Code CLI、Codex、Kimi CLI、Antigravity)を再起動すると GoDD MCP α サーバーが自動で起動します。GoDD ツールの呼び出し方法は 3 つあります。
434
-
435
- **方法 1 — クライアントネイティブの UI:** 各クライアントが提供する MCP プロンプト/ツールの UI を使います。例: Cursor ではチャット入力欄で `/` を入力してドロップダウンから GoDD プロンプト(`/dev`、`/review` 等)を選択します。Agent モードで自然言語(「dev して」「レビューして」)で指示しても、AI が該当ツールを自動的に検出して呼び出します。
436
-
437
- **方法 2 — ネイティブスラッシュコマンド(install 時に生成):** `godd-a install` はカスタムコマンド対応クライアントに `godd-a-<tool>.md` コマンドファイルを生成します — Cursor(`~/.cursor/commands/`)、Claude Code(`~/.claude/commands/`)、Codex(`$CODEX_HOME/prompts` または `~/.codex/prompts/`、セッション開始時にロード)、Antigravity(`~/.gemini/antigravity/workflows/` — コミュニティ情報ベース・公式未確認)。`/godd-a-dev`、`/godd-a-review` のように呼び出します(クライアントのコマンド名には `/` や `:` を使えないためハイフン形式)。Kimi CLI はカスタムスラッシュコマンド非対応のため生成されません。
438
-
439
- **方法 3 — `run` ツールへのテキストディスパッチ:** チャットに `/godd-a/dev <args>` とテキスト入力します。常時ロードされるディスパッチ規則(AGENTS.md の GoDD ブロックと `.cursor/rules/godd-stack.mdc`。`config` ツール(チャット経由)または `godd-a init` で再生成)により、AI が全文を GoDD MCP の `run` ツールに渡し、`run` が `/godd-a/<tool>`、`godd-a/<tool>`、`/godd-a:<tool>`、`/godd-a_<tool>`、`mcp__godd-a__<tool>`、ベア `/<tool>` の各形式をパースして対応ツールを実行します。
440
-
441
- ### トークン効率
442
-
443
- GoDD MCP はプロンプトを**オンデマンドで配信**します。呼び出したプロンプトだけが AI のコンテキストに送られます。全ルールを毎会話の開始から常時コンテキストに含める Cursor Rules とは根本的に異なります。
444
-
445
- | 方式 | 仕組み | 1回あたりのトークンコスト |
446
- |---|---|---|
447
- | **素の Cursor(GoDD なし)** | 構造化プロンプトなし、エージェントの試行回数が増加 | ~80,000+ tokens / タスク |
448
- | **GoDD MCP** | 最適化されたプロンプトをオンデマンド配信 | ~2,000〜5,000 tokens / 呼び出し |
449
-
450
- セッション中いつでも `/metrics` を実行すると、実際のトークン使用量と節約推定値を確認できます。節約効果は GoDD 使用時と未使用時の実測ベンチマークで計測されます。
166
+ クライアントが対応している方法で GoDD を呼び出せます。
451
167
 
452
- 任意の `quality_evidence` JSON を渡すと、過剰出力・実行完遂・設計健全性を
453
- 再現可能な計算式で評価できます。証拠不足は失敗と推測せず
454
- `INCONCLUSIVE` として報告します。
455
- 任意の `learning_evidence` には数値・真偽値の集計値だけを渡し、学習成果と
456
- 主張の根拠性を決定論的に評価できます。空または未完了の証拠は
457
- `INCONCLUSIVE` です。原文や秘密情報は渡さないでください。
168
+ - **ネイティブ UI** — チャットで `/` を入力して GoDD プロンプト(`/dev`, `/review` など)を選択、または Agent モードで自然文で依頼(「dev を実行」「レビューして」)。
169
+ - **スラッシュコマンド** — `godd-a install` が対応クライアント(Cursor / Claude Code / Codex / Antigravity)に `/godd-a-<tool>` コマンドファイルを生成します。
170
+ - **テキストディスパッチ** — チャットに `/godd-a/dev <args>` と入力すると、AI が対応ツールに振り分けます。
458
171
 
459
- ### GoDD Token Killer (godd-tk)
460
-
461
- **コマンド出力を圧縮し、トークンをさらに削減するバンドル CLI プロキシ。同梱ベンチマークで実測加重平均 88.1%(est.、コマンド種別レンジ 0〜94%)。**
462
-
463
- godd-tk は AI エージェントが実行するシェルコマンドの出力をインターセプトし、LLM に渡す前に圧縮します。`npm install` 時に自動でインストールされます。
464
-
465
- ```
466
- AI エージェント → Shell("git status") → godd-tk → 圧縮済み出力 → AI エージェント
467
- ```
468
-
469
- | 機能 | 説明 |
470
- |---|---|
471
- | 出力フィルタリング | ANSI コード、ノイズ行、冗長な書式を除去 |
472
- | 統計的圧縮 | 型別コンプレッサ(log / json / diff / test-report / generic-text)が反復出力を畳み込み、エラーや失敗詳細は全文保持 |
473
- | 可逆圧縮(CCR) | 圧縮前の生出力をローカルに全文保存。`godd-tk show <id>` でいつでも原文を参照可能 |
474
- | 使用量分析 | コマンドごとの節約トークン数を SQLite で追跡 |
475
- | 自動インストール | `npm install` 時に自動ダウンロード |
476
-
477
- `godd-tk gain` で累計トークン節約量を確認できます。
478
-
479
- 圧縮フックを自動設定するのは現時点では Cursor のみです。他の MCP
480
- クライアントは圧縮なしで利用を継続でき、`godd-tk exec -- <command>` で明示的に
481
- 圧縮できます。実装SSOT由来の表は `godd-a compatibility` で確認でき、実クライアントの
482
- OS別smoke testは証跡が追加されるまで `unverified` と表示されます。
483
-
484
- ### GoDD プロンプト一覧
485
-
486
- 各クライアントで利用できる GoDD プロンプト(MCP ツール)の一覧です。
172
+ ### GoDD プロンプト
487
173
 
488
174
  | プロンプト | 説明 |
489
175
  |---|---|
490
- | `run` | 統一エントリポイント — "/godd-a/<tool> <args>" 形式のテキストコマンドをパースして対応ツールを実行 |
491
- | `dev` | 開発(段階的に計画→実装→テスト→品質→ドキュメントを実行) |
176
+ | `run` | 統一エントリポイント — "/godd-a/<tool> <args>" 形式のテキストをパースして対応ツールを実行 |
177
+ | `dev` | 開発(段階的に計画→実装→テスト→品質→ドキュメント) |
492
178
  | `check` | 品質ゲート(Spec整合・テスト・型・Lint・セキュリティを検証) |
493
179
  | `docs` | ドキュメント生成/更新 |
494
180
  | `ship` | 提出(適切な粒度でコミット → 品質チェック → プッシュ → PR 作成) |
@@ -503,132 +189,62 @@ OS別smoke testは証跡が追加されるまで `unverified` と表示されま
503
189
  | `adr` | ADR(Architecture Decision Record)作成 |
504
190
  | `release` | リリースノート生成(SemVer 準拠) |
505
191
  | `github` | GitHub 設定(リポジトリ/ブランチ保護等) |
506
- | `config` | config.godd を正確に生成・修正する(スタック自動検出 + バリデーション) |
507
- | `questions` | 質問リスト(質問リスト.md)からインタラクティブに質問を管理 |
192
+ | `config` | config.godd を生成・修正(スタック自動検出 + バリデーション) |
193
+ | `questions` | 質問リストをインタラクティブに管理 |
508
194
  | `e2e` | ブラウザベース E2E テスト(重要ユーザーフローの実行・検証) |
509
195
  | `map` | プロジェクトナレッジグラフ(Mermaid でアーキテクチャ・依存関係を可視化) |
510
196
  | `learn` | プロジェクト固有のパターン・慣例・落とし穴を保存/参照 |
511
- | `scratchpad` | 会話記憶の永続化 — BM25 ベクター検索で save/recall/search/list/forget |
512
- | `diagram` | アーキテクチャ図の自動更新(コードと同期した Mermaid ドキュメントを維持) |
513
- | `slide` | プロジェクトドキュメントからプレゼンスライドを生成(Marp Markdown 形式) |
514
- | `design` | コードベースからビジュアルデザインを生成/更新(Pencil.dev 同期) |
515
- | `metrics` | トークン効率レポート — このセッションの配信トークン数と素の Cursor との比較(実測ベンチマークベース) |
197
+ | `scratchpad` | 会話記憶の永続化(save/recall/search/list/forget) |
198
+ | `diagram` | アーキテクチャ図の自動更新(コードと同期した Mermaid ドキュメント) |
199
+ | `slide` | プロジェクトドキュメントからプレゼンスライドを生成(Marp Markdown) |
200
+ | `design` | コードベースからビジュアルデザインを生成/更新 |
201
+ | `metrics` | このセッションのトークン効率レポート |
516
202
 
517
203
  ### CLI コマンド
518
204
 
519
205
  | コマンド | 説明 |
520
206
  |---|---|
521
- | `godd-a install [--license-key=KEY] [--client=...]` | MCP クライアントに登録(`cursor` / `claude-code` / `codex` / `kimi` / `antigravity` / `all`。省略時はインストール済みクライアントを自動検出) |
522
- | `godd-a init [--force] [--lang=LANG] [--auto]` | プロジェクトの config.godd を生成 |
523
- | `godd-a uninstall [--client=...]` | MCP クライアントから削除(`--client` の解決は install と同様) |
524
- | `godd-a compatibility` | 実装SSOT由来の godd-tk クライアント互換マトリクスを表示 |
525
- | `godd-a codec-capability verify [...]` | codec manifest・artifact・runtime probe・known-answerを同梱Rustで検証 |
526
- | `godd-a plan audit <record\|verify> [...]` | 改ざん検出可能な計画中断・再開・逸脱の証跡を記録・検証 |
527
- | `godd-a research <action> [options]` | Rust実行本体で匿名化済み調査チェックポイントを保存・再開(検索・LLM呼出なし) |
207
+ | `godd-a install [--license-key=KEY] [--client=...]` | MCP クライアントに登録(`--client` 省略時はインストール済みを自動検出) |
208
+ | `godd-a init [--force] [--lang=LANG] [--auto]` | プロジェクト設定を生成 |
209
+ | `godd-a uninstall [--client=...]` | MCP クライアントから削除 |
210
+ | `godd-a version`(または `--version` / `-v`) | インストール済みバージョンの表示と更新確認 |
528
211
  | `godd-a serve` | MCP stdio サーバーを起動(クライアントが自動呼び出し) |
529
- | `godd-a --version` / `godd-a -v` | インストール済みバージョンを表示 |
530
-
531
- ### スクラッチパッド(永続メモリ)
532
-
533
- GoDD にはセッションをまたいで会話記憶を保存・検索できるスクラッチパッドシステムが組み込まれています。
534
-
535
- GoDD MCP 起動時に Docker Desktop は自動的に起動されます(インストール済みの場合)。手動セットアップ:
536
-
537
- ```bash
538
- # ベクター検索用に Qdrant を起動(任意 — なくてもローカル JSON フォールバックで動作)
539
- cd godd-mcp-alpha && docker compose up -d
540
- ```
541
-
542
- | アクション | 例 | 説明 |
543
- |---|---|---|
544
- | `save` | `scratchpad save 認証フローは JWT + リフレッシュトークンを使用` | 記憶を保存し、`mem::` アドレスを返す |
545
- | `recall` | `scratchpad recall mem::godd::abc123` | アドレスで記憶の全文を取得 |
546
- | `search` | `scratchpad search 認証` | BM25 検索、上位 5 件を返す |
547
- | `list` | `scratchpad list` | 保存された記憶の一覧を表示 |
548
- | `forget` | `scratchpad forget mem::godd::abc123` | 記憶を削除 |
549
-
550
- Docker/Qdrant なしの場合は `.godd/scratchpad.json` にフォールバックし、キーワードベースの検索で動作します。
551
-
552
- ### ライセンスキーの取得
553
-
554
- GoDD MCP を利用するにはライセンスキーが必要です。以下の手順で取得できます。
555
-
556
- 1. [GoDD 公式サイト](https://www.getgodd.dev/pricing) でプランを確認
557
- 2. [アカウント登録](https://www.getgodd.dev/godd-admin/register) してサブスクリプションを購入
558
- 3. [ダッシュボード](https://www.getgodd.dev/godd-admin/dashboard) からライセンスキーを発行
559
-
560
- 発行されたライセンスキーを `godd-a install --license-key=YOUR_KEY` で設定してください。
561
-
562
- ### 動作要件
563
-
564
- - Node.js 22 以上
565
- - MCP 対応クライアント — Cursor IDE / Claude Code CLI / Codex / Kimi CLI / Antigravity IDE のいずれか
566
- - GoDD ライセンスキー([公式サイト](https://www.getgodd.dev/pricing)で取得)
567
212
 
568
213
  ### トラブルシューティング
569
214
 
570
- #### 「利用可能なツールが 0 個」と表示される
571
-
572
- Cursor の MCP ログに以下のようなエラーが出ている場合:
573
-
574
- ```
575
- Unexpected end of JSON input
576
- Unexpected token 'G', "GoDD MCP α"... is not valid JSON
577
- ```
578
-
579
- **原因**: `mcp.json` の `args` に `"serve"` が含まれていません。`serve` なしで起動するとインストーラーモード(人間向けテキスト出力)になり、Cursor が期待する JSON-RPC 通信に失敗します。
580
-
581
- **対処法**:
582
-
583
- ```bash
584
- # 再インストールで mcp.json を正しく再生成
585
- npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
586
- ```
587
-
588
- その後 Cursor を再起動してください。
589
-
590
- #### ライセンスキーが別の端末に紐づいていると表示される
591
-
592
- GoDD のライセンスキーは端末(デバイス)に紐づきます。別端末で使用する場合は新しいライセンスキーを発行してください。
593
-
594
- ```bash
595
- godd-a install --license-key=NEW_LICENSE_KEY
596
- ```
215
+ **クライアントに「0 tools available」と表示される** — サーバーが必須の `serve` 引数なしで起動されています。`godd-a install` を再実行してクライアント設定を正しく再生成し、クライアントを再起動してください。
597
216
 
598
217
  ### ライセンス
599
218
 
600
- Proprietary — GoDD ライセンスキーが必要です。[公式サイト](https://www.getgodd.dev/pricing)からご購入いただけます。
219
+ 商用(プロプライエタリ)。利用には有効な GoDD ライセンスキーが必要です。利用条件・サポートは[公式サイト](https://www.getgodd.dev/)をご覧ください。
601
220
 
602
221
  ---
603
222
 
604
- ### Version 2への移行とロールバック
223
+ ## Русский
224
+
225
+ **GoDD доставляет проверенные промпты для разработки, майндсеты и рабочие процессы агентов прямо в ваш AI-клиент для кодинга** — Cursor IDE, Claude Code CLI, Codex, Kimi CLI и Google Antigravity IDE — через протокол MCP (Model Context Protocol).
605
226
 
606
- Version 2でもpackage名、`npx`/global install、`godd-a` bin、MCP key、stdio transport、
607
- tool、config、永続state形式を維持します。Rust runtimeはnpm package内から直接実行し、
608
- 4対応targetをcommit済みdigest/size manifestで検証します。GitHub認証、`gh`、install中の
609
- 追加downloadは不要です。欠損・改竄・非対応・version不一致時はNode MCPへ縮退せず
610
- fail-closedで停止します。Linux x64はglibcに依存しないstatic musl binaryを使用し、
611
- Debian BookwormとAlpineでMCP smoke検証済みです。
227
+ ### Зачем использовать GoDD
612
228
 
613
- `npm install -g @autodevjapan/godd-mcp-alpha@2.0.0`で移行でき、既存MCP設定の変更は
614
- 不要です。rollbackは
615
- `npm install -g @autodevjapan/godd-mcp-alpha@1.46.3`を明示実行してください。
616
- `godd-tk`は別の任意機能で、`GODD_INSTALL_GODD_TK=1`の場合だけ導入を試行します。
229
+ - **Более качественный код быстрее.** Каждый промпт построен на семи проверенных методологиях xDD (Spec / Acceptance-Test / Test / Domain / Neo-Model / Docs / Issue-Driven Development), поэтому AI планирует, тестирует и документирует как senior-инженер, а не гадает.
230
+ - **Одна команда на задачу.** Вызовите `/dev`, `/review`, `/ship` и другие — AI выполнит полный цикл: план → реализация → тесты → качество → документация.
231
+ - **Меньше токенов, ниже стоимость.** Промпты доставляются **по требованию** — в контекст AI попадает только вызванный. Обычно это ~2 000–5 000 токенов на вызов против ~80 000+ у постоянно загружаемых файлов правил.
232
+ - **Работает с вашими клиентами.** Один и тот же сервер регистрируется во всех поддерживаемых клиентах; настройки проекта определяются автоматически.
233
+ - **Синхронизирован с вашим стеком.** `godd-a init` создаёт профиль проекта, чтобы доставляемые промпты соответствовали вашему языку, фреймворку и инструментам.
617
234
 
618
- ## Русский
235
+ ### Требования
619
236
 
620
- Система доставки AI-промптов для MCP-совместимых клиентов (Cursor IDE, Claude Code CLI, Codex, Kimi CLI, Google Antigravity IDE). Предоставляет оптимизированные под технологический стек проекта промпты, мировоззрения и определения агентов через MCP (Model Context Protocol). Сервер не зависит от клиента — одна и та же команда `serve` работает с любым MCP-хостом. Cursor, Claude Code, Codex, Kimi CLI и Antigravity официально поддерживаются.
237
+ - **Лицензионный ключ GoDD** (обязателен — см. [Получение лицензионного ключа](#получение-лицензионного-ключа))
238
+ - Node.js 22+
239
+ - MCP-совместимый клиент: Cursor IDE, Claude Code CLI, Codex, Kimi CLI или Antigravity IDE
621
240
 
622
- Пакет npm остаётся основным способом распространения. `godd-a serve` запускает MCP-среду на Rust; Node.js используется для жизненного цикла npm, установки нативного бинарного файла и совместимых CLI-команд.
623
- Инструменты `config`, `questions` и `scratchpad` запускают существующий обработчик Node.js только на время вызова для совместимости диагностики и формата хранения; сам MCP-сервер остаётся нативным для Rust.
241
+ ### Получение лицензионного ключа
624
242
 
625
- Команды `godd-a plan audit record` и `godd-a plan audit verify` записывают и
626
- проверяют защищённую HMAC-цепочкой историю остановок, возобновлений и отклонений
627
- плана. `GODD_PLAN_AUDIT_KEY` должен содержать не менее 32 байт.
243
+ Для использования GoDD MCP требуется действующий лицензионный ключ.
628
244
 
629
- Экспериментальный доменный контракт Rust проверяет явные маршруты
630
- `provider:model` для OpenAI-совместимых провайдеров. Он не запускает HTTP-прокси,
631
- не читает секреты, не выпускает виртуальные ключи и не меняет MCP-среду.
245
+ 1. Ознакомьтесь с тарифами на [официальном сайте GoDD](https://www.getgodd.dev/pricing)
246
+ 2. [Создайте аккаунт](https://www.getgodd.dev/godd-admin/register) и выберите подписку
247
+ 3. Выпустите лицензионный ключ в [панели управления](https://www.getgodd.dev/godd-admin/dashboard)
632
248
 
633
249
  ### Установка
634
250
 
@@ -636,164 +252,39 @@ Debian BookwormとAlpineでMCP smoke検証済みです。
636
252
  npm install -g @autodevjapan/godd-mcp-alpha
637
253
  ```
638
254
 
639
- ### Настройка (рекомендуется)
255
+ ### Настройка
640
256
 
641
257
  ```bash
642
- # Автоматически обнаружить установленные MCP-клиенты и зарегистрировать сервер в каждом
258
+ # Автообнаружение установленных MCP-клиентов и регистрация в каждом
643
259
  godd-a install --license-key=YOUR_LICENSE_KEY
644
260
 
645
- # Или указать конкретный клиент: cursor / claude-code / codex / kimi / antigravity / all
261
+ # Или конкретный клиент: cursor / claude-code / codex / kimi / antigravity / all
646
262
  godd-a install --client=cursor --license-key=YOUR_LICENSE_KEY
647
263
 
648
- # Автоматическая генерация config.godd для проекта (интерактивный режим)
264
+ # Сгенерировать конфигурацию проекта (интерактивно; для CI/CD добавьте --auto)
649
265
  godd-a init
650
-
651
- # Или полностью автоматический режим (для CI/CD)
652
- godd-a init --auto
653
- ```
654
-
655
- > **Используйте `godd-a install`.** Ручное редактирование mcp.json не рекомендуется.
656
- > `godd-a install` корректно настраивает команду запуска, PATH и лицензионный ключ.
657
-
658
- ### Ручная настройка mcp.json
659
-
660
- Если `godd-a install` недоступен, можно напрямую отредактировать конфигурационный файл клиента — `~/.cursor/mcp.json` для Cursor, `~/.gemini/antigravity/mcp_config.json` для Antigravity (оба используют общеизвестный формат `{"mcpServers": {...}}`). Если ни один известный клиент не обнаружен, `godd-a install` выводит этот же сниппет для ручной настройки.
661
- **Аргумент `serve` обязателен.** Без него запускается режим установщика, и MCP-коммуникация нарушается.
662
-
663
- ```json
664
- {
665
- "mcpServers": {
666
- "godd-a": {
667
- "command": "npx",
668
- "args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
669
- "env": {
670
- "GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
671
- }
672
- }
673
- }
674
- }
675
- ```
676
-
677
- ### Настройка в Claude Code CLI
678
-
679
- Зарегистрируйте сервер в Claude Code CLI с флагом `--client=claude-code`:
680
-
681
- ```bash
682
- godd-a install --client=claude-code --license-key=YOUR_LICENSE_KEY
683
- ```
684
-
685
- Регистрация делегируется `claude mcp add-json` в **user scope** (`~/.claude.json`) — безопасное слияние с другими MCP-серверами, повторный запуск обновляет существующую запись. Если `claude` CLI нет в PATH, установщик выведет точную команду для ручного выполнения.
686
-
687
- Без `--client` `godd-a install` автоматически обнаруживает локально установленные клиенты и регистрируется во всех найденных (если ни один не найден — выводит универсальный сниппет `mcpServers` для ручной настройки). Команда запуска, аргументы и переменные окружения идентичны для всех клиентов, а привязка лицензии выполняется по устройству.
688
-
689
- <details>
690
- <summary>Ручная регистрация (если не хотите использовать <code>godd-a install</code>)</summary>
691
-
692
- ```bash
693
- claude mcp add godd-a \
694
- --env GODD_LICENSE_KEY=GODD-XXXX-XXXX \
695
- -- npx -y @autodevjapan/godd-mcp-alpha@latest serve
696
- ```
697
-
698
- Либо добавьте файл `.mcp.json` в корне проекта с той же структурой `mcpServers` (аргумент `serve` обязателен).
699
- </details>
700
-
701
- ### Настройка в Codex
702
-
703
- Регистрация через официальный MCP CLI Codex. Codex CLI, расширение IDE и приложение используют общую MCP-конфигурацию:
704
-
705
- ```bash
706
- godd-a install --client=codex --license-key=YOUR_LICENSE_KEY
707
266
  ```
708
267
 
709
- Проверка: `codex mcp list` или `/mcp`. Удаление: `godd-a uninstall --client=codex`.
710
-
711
- ### Настройка в Kimi CLI
712
-
713
- Регистрация через официальную MCP-команду Kimi CLI:
714
-
715
- ```bash
716
- godd-a install --client=kimi --license-key=YOUR_LICENSE_KEY
717
- ```
718
-
719
- Регистрация делегируется `kimi mcp add --transport stdio` (переменные окружения передаются через `-e KEY=VALUE`). Если `kimi` CLI нет в PATH, установщик выведет команду для ручного выполнения. Проверка: `/mcp` в сессии Kimi CLI. Удаление: `godd-a uninstall --client=kimi`.
720
-
721
- ### Настройка в Antigravity
722
-
723
- Регистрация в MCP-конфигурации Google Antigravity IDE:
724
-
725
- ```bash
726
- godd-a install --client=antigravity --license-key=YOUR_LICENSE_KEY
727
- ```
728
-
729
- Общеизвестная запись `{"mcpServers": {...}}` объединяется в `~/.gemini/antigravity/mcp_config.json` без изменения других серверов. Удаление: `godd-a uninstall --client=antigravity`.
268
+ > Используйте `godd-a install` — он настроит команду запуска, PATH и лицензионный ключ. После этого перезапустите клиент, и инструменты GoDD появятся автоматически.
730
269
 
731
270
  ### Использование
732
271
 
733
- После установки перезапустите MCP-клиент (Cursor IDE, Claude Code CLI, Codex, Kimi CLI или Antigravity) — сервер GoDD MCP α запустится автоматически. Есть три способа вызвать инструменты GoDD:
734
-
735
- **Способ 1 — Нативный UI клиента:** Используйте интерфейс MCP-промптов/инструментов вашего клиента — например, в Cursor введите `/` в поле чата и выберите промпт GoDD из выпадающего списка (`/dev`, `/review`). В режиме Agent можно просто попросить AI естественным языком («запусти dev», «сделай review») — AI автоматически обнаружит и вызовет соответствующий инструмент.
736
-
737
- **Способ 2 — Нативные slash-команды (генерируются при установке):** `godd-a install` записывает файлы команд `godd-a-<tool>.md` в клиенты с поддержкой пользовательских команд — Cursor (`~/.cursor/commands/`), Claude Code (`~/.claude/commands/`), Codex (`$CODEX_HOME/prompts` или `~/.codex/prompts/`, загружаются при старте сессии), Antigravity (`~/.gemini/antigravity/workflows/` — путь из данных сообщества, официально не подтверждён). Вызывайте их как `/godd-a-dev`, `/godd-a-review` и т.д. — имена команд клиента не могут содержать `/` или `:`, поэтому используется форма с дефисом. Kimi CLI не поддерживает пользовательские slash-команды, поэтому файлы для него не генерируются.
738
-
739
- **Способ 3 — Текстовая диспетчеризация через инструмент `run`:** Введите `/godd-a/dev <args>` обычным текстом в чат. Постоянно загружаемые правила диспетчеризации (GoDD-блок в AGENTS.md и `.cursor/rules/godd-stack.mdc`, перегенерируются инструментом `config` (через чат) или командой `godd-a init`) указывают AI передать полный текст инструменту `run` GoDD MCP, который разбирает все обозначения — `/godd-a/<tool>`, `godd-a/<tool>`, `/godd-a:<tool>`, `/godd-a_<tool>`, `mcp__godd-a__<tool>`, голый `/<tool>` — и запускает соответствующий инструмент.
272
+ Вызывайте GoDD тем способом, который поддерживает ваш клиент:
740
273
 
741
- ### Эффективность токенов
274
+ - **Нативный UI** — введите `/` в чате и выберите промпт GoDD (`/dev`, `/review`), либо в режиме Agent просто попросите («запусти dev», «сделай ревью»).
275
+ - **Slash-команды** — `godd-a install` создаёт файлы команд `/godd-a-<tool>` для клиентов, которые их поддерживают (Cursor, Claude Code, Codex, Antigravity).
276
+ - **Текстовый диспетчер** — введите `/godd-a/dev <args>` как обычный текст; AI направит запрос нужному инструменту.
742
277
 
743
- GoDD MCP доставляет промпты **по требованию** — в контекст AI отправляется только вызванный промпт. Это принципиально отличается от Cursor Rules, где все правила загружаются в контекст с самого начала каждого чата.
744
-
745
- | Подход | Принцип работы | Стоимость токенов за вызов |
746
- |---|---|---|
747
- | **Cursor без GoDD** | Нет структурированных промптов; агент тратит больше итераций | ~80 000+ токенов на задачу |
748
- | **GoDD MCP** | Оптимизированные промпты по требованию | ~2 000–5 000 токенов за вызов |
749
-
750
- В любой момент сессии введите `/metrics`, чтобы увидеть фактическое использование токенов и расчётную экономию. Экономия измеряется эмпирически через бенчмарки, сравнивающие сессии с GoDD и без него.
751
-
752
- Необязательный аргумент JSON `quality_evidence` добавляет воспроизводимую
753
- оценку избыточного вывода, завершённости выполнения и целостности дизайна.
754
- Недостаточные доказательства дают `INCONCLUSIVE`, а не предполагаемый сбой.
755
- Необязательный `learning_evidence` принимает только числовые и логические
756
- агрегаты и детерминированно оценивает обучение и обоснованность. Пустые или
757
- неполные доказательства дают `INCONCLUSIVE`; исходный текст и секреты запрещены.
758
-
759
- ### GoDD Token Killer (godd-tk)
760
-
761
- **Встроенный CLI-прокси для дополнительной экономии токенов на вывод команд — измеренная средневзвешенная экономия 88.1% (est.) на встроенном бенчмарке (0–94% по типам команд).**
762
-
763
- godd-tk перехватывает команды оболочки, выполняемые AI-агентами, и сжимает их вывод перед отправкой в LLM. Автоматически устанавливается вместе с GoDD MCP через `npm postinstall`.
764
-
765
- ```
766
- AI-агент → Shell("git status") → godd-tk → сжатый вывод → AI-агент
767
- ```
768
-
769
- | Функция | Описание |
770
- |---|---|
771
- | Фильтрация вывода | Удаление ANSI-кодов, шумовых строк и избыточного форматирования |
772
- | Статистическое сжатие | Типизированные компрессоры (log / json / diff / test-report / generic-text) сворачивают повторяющийся вывод, сохраняя ошибки и детали сбоев полностью |
773
- | Обратимое сжатие (CCR) | Исходный вывод целиком сохраняется локально до сжатия — восстановление в любой момент через `godd-tk show <id>` |
774
- | Аналитика использования | Отслеживание сэкономленных токенов по командам через SQLite |
775
- | Автоустановка | Скачивается автоматически при `npm install` |
776
-
777
- Запустите `godd-tk gain` для просмотра накопленной экономии токенов.
778
-
779
- Автоматический хук сжатия сейчас настраивается только для Cursor. Остальные
780
- MCP-клиенты продолжают работать без сжатия; ручной режим:
781
- `godd-tk exec -- <command>`. Команда `godd-a compatibility` выводит матрицу из
782
- реестра реализации, а проверки реальных клиентов по ОС остаются `unverified`
783
- до появления результатов smoke-тестов.
784
-
785
- ### Список промптов GoDD
786
-
787
- Доступные промпты GoDD (MCP-инструменты):
278
+ ### Промпты GoDD
788
279
 
789
280
  | Промпт | Описание |
790
281
  |---|---|
791
- | `run` | Единая точка входа — разбирает текстовую команду "/godd-a/<tool> <args>" и запускает соответствующий инструмент |
282
+ | `run` | Единая точка входа — разбирает текстовую команду "/godd-a/<tool> <args>" и запускает нужный инструмент |
792
283
  | `dev` | Разработка (поэтапно: план → реализация → тесты → качество → документация) |
793
- | `check` | Контроль качества (проверка соответствия спецификации, тесты, типы, линтер, безопасность) |
284
+ | `check` | Контроль качества (соответствие спецификации, тесты, типы, линтер, безопасность) |
794
285
  | `docs` | Генерация/обновление документации |
795
- | `ship` | Отправка (коммит с правильной гранулярностью → проверка качества → push → создание PR) |
796
- | `setup` | Настройка среды (с рекомендуемыми пресетами стека, уточнение недостающей информации) |
286
+ | `ship` | Отправка (коммит нужной гранулярности → проверка качества → push → создание PR) |
287
+ | `setup` | Настройка среды (с рекомендуемыми пресетами стека) |
797
288
  | `review` | Ревью (уровень CTO + контроль качества) |
798
289
  | `test` | Запуск/создание тестов |
799
290
  | `impact` | Анализ влияния |
@@ -802,118 +293,33 @@ MCP-клиенты продолжают работать без сжатия; р
802
293
  | `pr` | Создание PR (по шаблону) |
803
294
  | `deploy` | Деплой (с верификацией и планом отката) |
804
295
  | `adr` | Создание ADR (Architecture Decision Record) |
805
- | `release` | Генерация заметок к релизу (SemVer-совместимые) |
296
+ | `release` | Генерация заметок к релизу (SemVer) |
806
297
  | `github` | Настройка GitHub (защита репозитория/веток и т.д.) |
807
298
  | `config` | Генерация/исправление config.godd (автодетект стека + валидация) |
808
- | `questions` | Управление списком вопросов (質問リスト.md) в интерактивном режиме |
809
- | `e2e` | E2E-тестирование в браузере (выполнение и проверка критических пользовательских потоков) |
810
- | `map` | Граф знаний проекта (визуализация архитектуры и зависимостей через Mermaid) |
811
- | `learn` | Сохранение/вызов специфичных для проекта паттернов, соглашений и подводных камней |
812
- | `scratchpad` | Постоянная память диалога — save/recall/search/list/forget с BM25 векторным поиском |
813
- | `diagram` | Автообновление архитектурных диаграмм (поддержка актуальных Mermaid-документов) |
814
- | `slide` | Генерация презентационных слайдов из документации проекта (формат Marp Markdown) |
815
- | `design` | Генерация/обновление визуального дизайна из кодовой базы (синхронизация с Pencil.dev) |
816
- | `metrics` | Отчёт об эффективности токенов — токены этой сессии vs. базовый уровень Cursor без GoDD (на основе бенчмарков) |
299
+ | `questions` | Интерактивное управление списком вопросов |
300
+ | `e2e` | E2E-тестирование в браузере (критические пользовательские потоки) |
301
+ | `map` | Граф знаний проекта (архитектура и зависимости через Mermaid) |
302
+ | `learn` | Сохранение/вызов паттернов, соглашений и подводных камней проекта |
303
+ | `scratchpad` | Постоянная память диалога (save/recall/search/list/forget) |
304
+ | `diagram` | Автообновление архитектурных диаграмм (Mermaid в синхронизации с кодом) |
305
+ | `slide` | Генерация слайдов из документации проекта (Marp Markdown) |
306
+ | `design` | Генерация/обновление визуального дизайна из кодовой базы |
307
+ | `metrics` | Отчёт об эффективности токенов текущей сессии |
817
308
 
818
309
  ### Команды CLI
819
310
 
820
311
  | Команда | Описание |
821
312
  |---|---|
822
- | `godd-a install [--license-key=KEY] [--client=...]` | Зарегистрировать MCP-сервер в клиентах (`cursor` / `claude-code` / `codex` / `kimi` / `antigravity` / `all`; без `--client` — автообнаружение установленных) |
823
- | `godd-a init [--force] [--lang=LANG] [--auto]` | Сгенерировать config.godd для проекта |
824
- | `godd-a uninstall [--client=...]` | Удалить MCP-сервер из клиентов (разрешение `--client` как у install) |
825
- | `godd-a compatibility` | Показать матрицу совместимости godd-tk из реестра реализации |
826
- | `godd-a codec-capability verify [...]` | Проверить manifest, artifact, runtime probe и known-answer кодека во встроенной Rust-среде |
827
- | `godd-a plan audit <record\|verify> [...]` | Записать или проверить историю остановок, возобновлений и отклонений плана |
828
- | `godd-a research <action> [options]` | Сохранить или продолжить обезличенную контрольную точку в Rust (без поиска и LLM) |
829
- | `godd-a serve` | Запустить MCP stdio-сервер (автоматически вызывается клиентом) |
830
- | `godd-a --version` / `godd-a -v` | Показать установленную версию |
831
-
832
- ### Скрэтчпад (постоянная память)
833
-
834
- GoDD включает систему скрэтчпада для сохранения и поиска воспоминаний между сессиями.
835
-
836
- Docker Desktop автоматически запускается при старте GoDD MCP (если установлен). Для ручной настройки:
837
-
838
- ```bash
839
- # Запустить Qdrant для векторного поиска (опционально — работает и без него через локальный JSON)
840
- cd godd-mcp-alpha && docker compose up -d
841
- ```
842
-
843
- | Действие | Пример | Описание |
844
- |---|---|---|
845
- | `save` | `scratchpad save Авторизация использует JWT + refresh-токены` | Сохранить запись, возвращает адрес `mem::` |
846
- | `recall` | `scratchpad recall mem::godd::abc123` | Получить полное содержимое по адресу |
847
- | `search` | `scratchpad search авторизация` | BM25-поиск, возвращает топ-5 результатов |
848
- | `list` | `scratchpad list` | Показать все сохранённые записи |
849
- | `forget` | `scratchpad forget mem::godd::abc123` | Удалить запись |
850
-
851
- Без Docker/Qdrant скрэтчпад использует `.godd/scratchpad.json` с поиском по ключевым словам.
852
-
853
- ### Получение лицензионного ключа
854
-
855
- Для использования GoDD MCP необходим лицензионный ключ. Получите его следующим образом:
856
-
857
- 1. Ознакомьтесь с тарифными планами на [официальном сайте GoDD](https://www.getgodd.dev/pricing)
858
- 2. [Зарегистрируйте аккаунт](https://www.getgodd.dev/godd-admin/register) и приобретите подписку
859
- 3. Выпустите лицензионный ключ в [личном кабинете](https://www.getgodd.dev/godd-admin/dashboard)
860
-
861
- Установите полученный ключ командой `godd-a install --license-key=YOUR_KEY`.
862
-
863
- ### Системные требования
864
-
865
- - Node.js 22+
866
- - MCP-совместимый клиент — Cursor IDE, Claude Code CLI, Codex, Kimi CLI или Antigravity IDE
867
- - Лицензионный ключ GoDD (получите на [официальном сайте](https://www.getgodd.dev/pricing))
313
+ | `godd-a install [--license-key=KEY] [--client=...]` | Регистрация в MCP-клиентах (без `--client` — автообнаружение установленных) |
314
+ | `godd-a init [--force] [--lang=LANG] [--auto]` | Генерация конфигурации проекта |
315
+ | `godd-a uninstall [--client=...]` | Удаление из MCP-клиентов |
316
+ | `godd-a version` (или `--version` / `-v`) | Показать установленную версию и проверить обновления |
317
+ | `godd-a serve` | Запустить MCP stdio-сервер (вызывается клиентом автоматически) |
868
318
 
869
319
  ### Устранение неполадок
870
320
 
871
- #### Отображается «0 доступных инструментов»
872
-
873
- Если в логах MCP Cursor отображаются ошибки вида:
874
-
875
- ```
876
- Unexpected end of JSON input
877
- Unexpected token 'G', "GoDD MCP α"... is not valid JSON
878
- ```
879
-
880
- **Причина**: В `args` файла `mcp.json` отсутствует `"serve"`. Без него запускается режим установщика (текстовый вывод для человека), что нарушает JSON-RPC коммуникацию, ожидаемую Cursor.
881
-
882
- **Решение**:
883
-
884
- ```bash
885
- # Переустановите для правильной регенерации mcp.json
886
- npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
887
- ```
888
-
889
- Затем перезапустите Cursor.
890
-
891
- #### Лицензионный ключ привязан к другому устройству
892
-
893
- Лицензионные ключи GoDD привязываются к устройству. Для использования на другом устройстве выпустите новый ключ.
894
-
895
- ```bash
896
- godd-a install --license-key=NEW_LICENSE_KEY
897
- ```
898
-
899
- ### Переход на Version 2 и откат
900
-
901
- Version 2 сохраняет имя пакета, установку через `npx`/global, бинарный файл `godd-a`,
902
- MCP key, stdio transport, инструменты, config и формат постоянного состояния. Среда Rust
903
- запускается непосредственно из npm package. Четыре поддерживаемых target проверяются по
904
- зафиксированному manifest с digest и size; GitHub authentication, `gh` и дополнительная
905
- загрузка при установке не требуются. При отсутствии, подмене, неподдерживаемой платформе или
906
- несовпадении версии установка завершается с ошибкой без Node MCP fallback.
907
- Для Linux x64 используется статический бинарный файл musl без зависимости от glibc;
908
- MCP smoke-тест подтверждён на Debian Bookworm и Alpine.
909
-
910
- Для обновления выполните
911
- `npm install -g @autodevjapan/godd-mcp-alpha@2.0.0`; существующая MCP-конфигурация не
912
- меняется. Для явного отката используйте
913
- `npm install -g @autodevjapan/godd-mcp-alpha@1.46.3`.
914
- `godd-tk` является отдельной необязательной возможностью и устанавливается только при
915
- `GODD_INSTALL_GODD_TK=1`.
321
+ **«0 tools available» в клиенте** — сервер запущен без обязательного аргумента `serve`. Повторно выполните `godd-a install`, чтобы корректно пересоздать конфигурацию клиента, затем перезапустите клиент.
916
322
 
917
323
  ### Лицензия
918
324
 
919
- Проприетарная — требуется лицензионный ключ GoDD. Приобретите на [официальном сайте](https://www.getgodd.dev/pricing).
325
+ Проприетарное ПО. Для использования требуется действующий лицензионный ключ GoDD. Условия и поддержка — на [официальном сайте](https://www.getgodd.dev/).