@autodevjapan/godd-mcp-alpha 1.25.17 → 1.25.19
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 +305 -16
- package/dist/godd.cjs +40287 -306
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,162 @@
|
|
|
1
1
|
# GoDD MCP α Server
|
|
2
2
|
|
|
3
|
+
[🇺🇸 English](#english) | [🇯🇵 日本語](#日本語) | [🇷🇺 Русский](#русский)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## English
|
|
8
|
+
|
|
9
|
+
AI prompt delivery system for Cursor IDE. Delivers project-optimized prompts, mindsets, and agent definitions via MCP (Model Context Protocol).
|
|
10
|
+
|
|
11
|
+
### Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g @autodevjapan/godd-mcp-alpha
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Setup (Recommended)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Register the MCP server with Cursor IDE (auto-generates mcp.json)
|
|
21
|
+
godd-a install --license-key=YOUR_LICENSE_KEY
|
|
22
|
+
|
|
23
|
+
# Auto-generate project config.godd (interactive)
|
|
24
|
+
godd-a init
|
|
25
|
+
|
|
26
|
+
# Or fully automatic mode (for CI/CD)
|
|
27
|
+
godd-a init --auto
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
> **Use `godd-a install`.** Manual editing of mcp.json is not recommended.
|
|
31
|
+
> `godd-a install` correctly configures the startup command, PATH, and license key.
|
|
32
|
+
|
|
33
|
+
### Manual mcp.json Configuration
|
|
34
|
+
|
|
35
|
+
If `godd-a install` is unavailable, you can edit `~/.cursor/mcp.json` directly.
|
|
36
|
+
**The `serve` argument is required.** Without it, the installer mode starts and MCP communication breaks.
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"mcpServers": {
|
|
41
|
+
"godd-a": {
|
|
42
|
+
"command": "npx",
|
|
43
|
+
"args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
|
|
44
|
+
"env": {
|
|
45
|
+
"GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Usage
|
|
53
|
+
|
|
54
|
+
After installation, restart Cursor IDE and the GoDD MCP α server will start automatically.
|
|
55
|
+
|
|
56
|
+
In Cursor chat, simply ask the AI to use a specific tool (e.g., "run dev", "do a review"). The AI will automatically discover and invoke the appropriate GoDD tool.
|
|
57
|
+
|
|
58
|
+
### GoDD Prompts
|
|
59
|
+
|
|
60
|
+
Available GoDD prompts (MCP tools) in Cursor IDE:
|
|
61
|
+
|
|
62
|
+
| Prompt | Description |
|
|
63
|
+
|---|---|
|
|
64
|
+
| `dev` | Development (plan → implement → test → quality → docs in stages) |
|
|
65
|
+
| `check` | Quality gate (verify spec alignment, tests, types, lint, security) |
|
|
66
|
+
| `docs` | Generate/update documentation |
|
|
67
|
+
| `ship` | Ship (commit at proper granularity → quality check → push → create PR) |
|
|
68
|
+
| `setup` | Environment setup (with recommended stack presets, confirms missing info) |
|
|
69
|
+
| `review` | Review (CTO-level review + quality gate) |
|
|
70
|
+
| `test` | Run/create tests |
|
|
71
|
+
| `impact` | Impact analysis |
|
|
72
|
+
| `commit` | Commit changes |
|
|
73
|
+
| `push` | Push to remote |
|
|
74
|
+
| `pr` | Create PR (template-compliant) |
|
|
75
|
+
| `deploy` | Deploy (with verification & rollback plan) |
|
|
76
|
+
| `adr` | Create ADR (Architecture Decision Record) |
|
|
77
|
+
| `release` | Generate release notes (SemVer-compliant) |
|
|
78
|
+
| `github` | GitHub configuration (repository/branch protection etc.) |
|
|
79
|
+
| `config` | Generate/repair config.godd (auto-detect stack + validation) |
|
|
80
|
+
| `questions` | Manage question list (質問リスト.md) interactively |
|
|
81
|
+
| `e2e` | Browser-based E2E testing (execute & verify critical user flows) |
|
|
82
|
+
| `map` | Project knowledge graph (visualize architecture & dependencies with Mermaid) |
|
|
83
|
+
| `learn` | Save/recall project-specific patterns, conventions, and pitfalls |
|
|
84
|
+
| `diagram` | Auto-update architecture diagrams (maintain living Mermaid docs in sync with code) |
|
|
85
|
+
| `slide` | Generate presentation slides from project docs (Marp Markdown format) |
|
|
86
|
+
| `design` | Generate/update visual designs from codebase (Pencil.dev sync) |
|
|
87
|
+
|
|
88
|
+
### CLI Commands
|
|
89
|
+
|
|
90
|
+
| Command | Description |
|
|
91
|
+
|---|---|
|
|
92
|
+
| `godd-a install [--license-key=KEY]` | Register MCP server with Cursor |
|
|
93
|
+
| `godd-a init [--force] [--lang=LANG] [--auto]` | Generate project config.godd |
|
|
94
|
+
| `godd-a uninstall` | Remove MCP server from Cursor |
|
|
95
|
+
| `godd-a serve` | Start MCP stdio server (auto-invoked by Cursor) |
|
|
96
|
+
|
|
97
|
+
### Getting a License Key
|
|
98
|
+
|
|
99
|
+
A license key is required to use GoDD MCP. Follow these steps:
|
|
100
|
+
|
|
101
|
+
1. Check plans at the [GoDD official site](https://www.getgodd.dev/pricing)
|
|
102
|
+
2. [Register an account](https://www.getgodd.dev/godd-admin/register) and purchase a subscription
|
|
103
|
+
3. Issue a license key from your [dashboard](https://www.getgodd.dev/godd-admin/dashboard)
|
|
104
|
+
|
|
105
|
+
Set the issued license key with `godd-a install --license-key=YOUR_KEY`.
|
|
106
|
+
|
|
107
|
+
### Requirements
|
|
108
|
+
|
|
109
|
+
- Node.js 22+
|
|
110
|
+
- Cursor IDE
|
|
111
|
+
- GoDD license key (get one at [official site](https://www.getgodd.dev/pricing))
|
|
112
|
+
|
|
113
|
+
### Troubleshooting
|
|
114
|
+
|
|
115
|
+
#### "0 tools available" is shown
|
|
116
|
+
|
|
117
|
+
If Cursor's MCP log shows errors like:
|
|
118
|
+
|
|
119
|
+
```
|
|
120
|
+
Unexpected end of JSON input
|
|
121
|
+
Unexpected token 'G', "GoDD MCP α"... is not valid JSON
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**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.
|
|
125
|
+
|
|
126
|
+
**Fix**:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
# Reinstall to regenerate mcp.json correctly
|
|
130
|
+
npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Then restart Cursor.
|
|
134
|
+
|
|
135
|
+
#### License key is bound to another device
|
|
136
|
+
|
|
137
|
+
GoDD license keys are bound to a device. To use on a different device, issue a new license key.
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
godd-a install --license-key=NEW_LICENSE_KEY
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### License
|
|
144
|
+
|
|
145
|
+
Proprietary — A GoDD license key is required. Purchase at the [official site](https://www.getgodd.dev/pricing).
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## 日本語
|
|
150
|
+
|
|
3
151
|
Cursor IDE 向けの AI プロンプト配信システム。MCP (Model Context Protocol) を通じて、プロジェクトの技術スタックに最適化されたプロンプト・マインドセット・エージェント定義を提供します。
|
|
4
152
|
|
|
5
|
-
|
|
153
|
+
### インストール
|
|
6
154
|
|
|
7
155
|
```bash
|
|
8
156
|
npm install -g @autodevjapan/godd-mcp-alpha
|
|
9
157
|
```
|
|
10
158
|
|
|
11
|
-
|
|
159
|
+
### セットアップ（推奨）
|
|
12
160
|
|
|
13
161
|
```bash
|
|
14
162
|
# Cursor IDE に MCP サーバーを登録（mcp.json を自動生成）
|
|
@@ -21,12 +169,12 @@ godd-a init
|
|
|
21
169
|
godd-a init --auto
|
|
22
170
|
```
|
|
23
171
|
|
|
24
|
-
> **`godd-a install` を使ってください。** mcp.json の手動編集は非推奨です。
|
|
172
|
+
> **`godd-a install` を使ってください。** mcp.json の手動編集は非推奨です。
|
|
25
173
|
> `godd-a install` は起動コマンド・PATH・ライセンスキーを正しく設定します。
|
|
26
174
|
|
|
27
|
-
|
|
175
|
+
### mcp.json を手動で設定する場合
|
|
28
176
|
|
|
29
|
-
`godd-a install` が使えない環境では、`~/.cursor/mcp.json` を直接編集できます。
|
|
177
|
+
`godd-a install` が使えない環境では、`~/.cursor/mcp.json` を直接編集できます。
|
|
30
178
|
**`serve` 引数は必須です。** 省略するとインストーラーモードで起動し、MCP 通信が破綻します。
|
|
31
179
|
|
|
32
180
|
```json
|
|
@@ -43,13 +191,13 @@ godd-a init --auto
|
|
|
43
191
|
}
|
|
44
192
|
```
|
|
45
193
|
|
|
46
|
-
|
|
194
|
+
### 使い方
|
|
47
195
|
|
|
48
196
|
インストール後、Cursor IDE を再起動すると GoDD MCP α サーバーが自動で起動します。
|
|
49
197
|
|
|
50
|
-
Cursor のチャットで
|
|
198
|
+
Cursor のチャットで AI に使いたいツールを指示してください（例：「dev して」「レビューして」）。AI が GoDD のツールを自動的に検出して呼び出します。
|
|
51
199
|
|
|
52
|
-
|
|
200
|
+
### GoDD プロンプト一覧
|
|
53
201
|
|
|
54
202
|
Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一覧です。
|
|
55
203
|
|
|
@@ -73,14 +221,13 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
|
|
|
73
221
|
| `config` | config.godd を正確に生成・修正する（スタック自動検出 + バリデーション） |
|
|
74
222
|
| `questions` | 質問リスト（質問リスト.md）からインタラクティブに質問を管理 |
|
|
75
223
|
| `e2e` | ブラウザベース E2E テスト（重要ユーザーフローの実行・検証） |
|
|
76
|
-
| `benchmark` | 競合プロンプト分析（GoDD vs Cursor Rules / Claude Code / Codex を比較） |
|
|
77
224
|
| `map` | プロジェクトナレッジグラフ（Mermaid でアーキテクチャ・依存関係を可視化） |
|
|
78
225
|
| `learn` | プロジェクト固有のパターン・慣例・落とし穴を保存/参照 |
|
|
79
226
|
| `diagram` | アーキテクチャ図の自動更新（コードと同期した Mermaid ドキュメントを維持） |
|
|
80
227
|
| `slide` | プロジェクトドキュメントからプレゼンスライドを生成（Marp Markdown 形式） |
|
|
81
228
|
| `design` | コードベースからビジュアルデザインを生成/更新（Pencil.dev 同期） |
|
|
82
229
|
|
|
83
|
-
|
|
230
|
+
### CLI コマンド
|
|
84
231
|
|
|
85
232
|
| コマンド | 説明 |
|
|
86
233
|
|---|---|
|
|
@@ -89,7 +236,7 @@ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一
|
|
|
89
236
|
| `godd-a uninstall` | Cursor から MCP サーバーを削除 |
|
|
90
237
|
| `godd-a serve` | MCP stdio サーバーを起動（Cursor が自動呼び出し） |
|
|
91
238
|
|
|
92
|
-
|
|
239
|
+
### ライセンスキーの取得
|
|
93
240
|
|
|
94
241
|
GoDD MCP を利用するにはライセンスキーが必要です。以下の手順で取得できます。
|
|
95
242
|
|
|
@@ -99,15 +246,15 @@ GoDD MCP を利用するにはライセンスキーが必要です。以下の
|
|
|
99
246
|
|
|
100
247
|
発行されたライセンスキーを `godd-a install --license-key=YOUR_KEY` で設定してください。
|
|
101
248
|
|
|
102
|
-
|
|
249
|
+
### 動作要件
|
|
103
250
|
|
|
104
251
|
- Node.js 22 以上
|
|
105
252
|
- Cursor IDE
|
|
106
253
|
- GoDD ライセンスキー（[公式サイト](https://www.getgodd.dev/pricing)で取得）
|
|
107
254
|
|
|
108
|
-
|
|
255
|
+
### トラブルシューティング
|
|
109
256
|
|
|
110
|
-
|
|
257
|
+
#### 「利用可能なツールが 0 個」と表示される
|
|
111
258
|
|
|
112
259
|
Cursor の MCP ログに以下のようなエラーが出ている場合:
|
|
113
260
|
|
|
@@ -127,7 +274,7 @@ npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
|
|
|
127
274
|
|
|
128
275
|
その後 Cursor を再起動してください。
|
|
129
276
|
|
|
130
|
-
|
|
277
|
+
#### ライセンスキーが別の端末に紐づいていると表示される
|
|
131
278
|
|
|
132
279
|
GoDD のライセンスキーは端末（デバイス）に紐づきます。別端末で使用する場合は新しいライセンスキーを発行してください。
|
|
133
280
|
|
|
@@ -135,6 +282,148 @@ GoDD のライセンスキーは端末（デバイス）に紐づきます。別
|
|
|
135
282
|
godd-a install --license-key=NEW_LICENSE_KEY
|
|
136
283
|
```
|
|
137
284
|
|
|
138
|
-
|
|
285
|
+
### ライセンス
|
|
139
286
|
|
|
140
287
|
Proprietary — GoDD ライセンスキーが必要です。[公式サイト](https://www.getgodd.dev/pricing)からご購入いただけます。
|
|
288
|
+
|
|
289
|
+
---
|
|
290
|
+
|
|
291
|
+
## Русский
|
|
292
|
+
|
|
293
|
+
Система доставки AI-промптов для Cursor IDE. Предоставляет оптимизированные под технологический стек проекта промпты, мировоззрения и определения агентов через MCP (Model Context Protocol).
|
|
294
|
+
|
|
295
|
+
### Установка
|
|
296
|
+
|
|
297
|
+
```bash
|
|
298
|
+
npm install -g @autodevjapan/godd-mcp-alpha
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Настройка (рекомендуется)
|
|
302
|
+
|
|
303
|
+
```bash
|
|
304
|
+
# Зарегистрировать MCP-сервер в Cursor IDE (автоматическая генерация mcp.json)
|
|
305
|
+
godd-a install --license-key=YOUR_LICENSE_KEY
|
|
306
|
+
|
|
307
|
+
# Автоматическая генерация config.godd для проекта (интерактивный режим)
|
|
308
|
+
godd-a init
|
|
309
|
+
|
|
310
|
+
# Или полностью автоматический режим (для CI/CD)
|
|
311
|
+
godd-a init --auto
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
> **Используйте `godd-a install`.** Ручное редактирование mcp.json не рекомендуется.
|
|
315
|
+
> `godd-a install` корректно настраивает команду запуска, PATH и лицензионный ключ.
|
|
316
|
+
|
|
317
|
+
### Ручная настройка mcp.json
|
|
318
|
+
|
|
319
|
+
Если `godd-a install` недоступен, можно напрямую отредактировать `~/.cursor/mcp.json`.
|
|
320
|
+
**Аргумент `serve` обязателен.** Без него запускается режим установщика, и MCP-коммуникация нарушается.
|
|
321
|
+
|
|
322
|
+
```json
|
|
323
|
+
{
|
|
324
|
+
"mcpServers": {
|
|
325
|
+
"godd-a": {
|
|
326
|
+
"command": "npx",
|
|
327
|
+
"args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
|
|
328
|
+
"env": {
|
|
329
|
+
"GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Использование
|
|
337
|
+
|
|
338
|
+
После установки перезапустите Cursor IDE — сервер GoDD MCP α запустится автоматически.
|
|
339
|
+
|
|
340
|
+
В чате Cursor просто попросите AI использовать нужный инструмент (например, «запусти dev», «сделай review»). AI автоматически обнаружит и вызовет соответствующий инструмент GoDD.
|
|
341
|
+
|
|
342
|
+
### Список промптов GoDD
|
|
343
|
+
|
|
344
|
+
Доступные промпты GoDD (MCP-инструменты) в Cursor IDE:
|
|
345
|
+
|
|
346
|
+
| Промпт | Описание |
|
|
347
|
+
|---|---|
|
|
348
|
+
| `dev` | Разработка (поэтапно: план → реализация → тесты → качество → документация) |
|
|
349
|
+
| `check` | Контроль качества (проверка соответствия спецификации, тесты, типы, линтер, безопасность) |
|
|
350
|
+
| `docs` | Генерация/обновление документации |
|
|
351
|
+
| `ship` | Отправка (коммит с правильной гранулярностью → проверка качества → push → создание PR) |
|
|
352
|
+
| `setup` | Настройка среды (с рекомендуемыми пресетами стека, уточнение недостающей информации) |
|
|
353
|
+
| `review` | Ревью (уровень CTO + контроль качества) |
|
|
354
|
+
| `test` | Запуск/создание тестов |
|
|
355
|
+
| `impact` | Анализ влияния |
|
|
356
|
+
| `commit` | Коммит изменений |
|
|
357
|
+
| `push` | Push на удалённый репозиторий |
|
|
358
|
+
| `pr` | Создание PR (по шаблону) |
|
|
359
|
+
| `deploy` | Деплой (с верификацией и планом отката) |
|
|
360
|
+
| `adr` | Создание ADR (Architecture Decision Record) |
|
|
361
|
+
| `release` | Генерация заметок к релизу (SemVer-совместимые) |
|
|
362
|
+
| `github` | Настройка GitHub (защита репозитория/веток и т.д.) |
|
|
363
|
+
| `config` | Генерация/исправление config.godd (автодетект стека + валидация) |
|
|
364
|
+
| `questions` | Управление списком вопросов (質問リスト.md) в интерактивном режиме |
|
|
365
|
+
| `e2e` | E2E-тестирование в браузере (выполнение и проверка критических пользовательских потоков) |
|
|
366
|
+
| `map` | Граф знаний проекта (визуализация архитектуры и зависимостей через Mermaid) |
|
|
367
|
+
| `learn` | Сохранение/вызов специфичных для проекта паттернов, соглашений и подводных камней |
|
|
368
|
+
| `diagram` | Автообновление архитектурных диаграмм (поддержка актуальных Mermaid-документов) |
|
|
369
|
+
| `slide` | Генерация презентационных слайдов из документации проекта (формат Marp Markdown) |
|
|
370
|
+
| `design` | Генерация/обновление визуального дизайна из кодовой базы (синхронизация с Pencil.dev) |
|
|
371
|
+
|
|
372
|
+
### Команды CLI
|
|
373
|
+
|
|
374
|
+
| Команда | Описание |
|
|
375
|
+
|---|---|
|
|
376
|
+
| `godd-a install [--license-key=KEY]` | Зарегистрировать MCP-сервер в Cursor |
|
|
377
|
+
| `godd-a init [--force] [--lang=LANG] [--auto]` | Сгенерировать config.godd для проекта |
|
|
378
|
+
| `godd-a uninstall` | Удалить MCP-сервер из Cursor |
|
|
379
|
+
| `godd-a serve` | Запустить MCP stdio-сервер (автоматически вызывается Cursor) |
|
|
380
|
+
|
|
381
|
+
### Получение лицензионного ключа
|
|
382
|
+
|
|
383
|
+
Для использования GoDD MCP необходим лицензионный ключ. Получите его следующим образом:
|
|
384
|
+
|
|
385
|
+
1. Ознакомьтесь с тарифными планами на [официальном сайте GoDD](https://www.getgodd.dev/pricing)
|
|
386
|
+
2. [Зарегистрируйте аккаунт](https://www.getgodd.dev/godd-admin/register) и приобретите подписку
|
|
387
|
+
3. Выпустите лицензионный ключ в [личном кабинете](https://www.getgodd.dev/godd-admin/dashboard)
|
|
388
|
+
|
|
389
|
+
Установите полученный ключ командой `godd-a install --license-key=YOUR_KEY`.
|
|
390
|
+
|
|
391
|
+
### Системные требования
|
|
392
|
+
|
|
393
|
+
- Node.js 22+
|
|
394
|
+
- Cursor IDE
|
|
395
|
+
- Лицензионный ключ GoDD (получите на [официальном сайте](https://www.getgodd.dev/pricing))
|
|
396
|
+
|
|
397
|
+
### Устранение неполадок
|
|
398
|
+
|
|
399
|
+
#### Отображается «0 доступных инструментов»
|
|
400
|
+
|
|
401
|
+
Если в логах MCP Cursor отображаются ошибки вида:
|
|
402
|
+
|
|
403
|
+
```
|
|
404
|
+
Unexpected end of JSON input
|
|
405
|
+
Unexpected token 'G', "GoDD MCP α"... is not valid JSON
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
**Причина**: В `args` файла `mcp.json` отсутствует `"serve"`. Без него запускается режим установщика (текстовый вывод для человека), что нарушает JSON-RPC коммуникацию, ожидаемую Cursor.
|
|
409
|
+
|
|
410
|
+
**Решение**:
|
|
411
|
+
|
|
412
|
+
```bash
|
|
413
|
+
# Переустановите для правильной регенерации mcp.json
|
|
414
|
+
npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
Затем перезапустите Cursor.
|
|
418
|
+
|
|
419
|
+
#### Лицензионный ключ привязан к другому устройству
|
|
420
|
+
|
|
421
|
+
Лицензионные ключи GoDD привязываются к устройству. Для использования на другом устройстве выпустите новый ключ.
|
|
422
|
+
|
|
423
|
+
```bash
|
|
424
|
+
godd-a install --license-key=NEW_LICENSE_KEY
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Лицензия
|
|
428
|
+
|
|
429
|
+
Проприетарная — требуется лицензионный ключ GoDD. Приобретите на [официальном сайте](https://www.getgodd.dev/pricing).
|