@autodevjapan/godd-mcp-alpha 0.22.0 → 0.24.0

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.
Files changed (3) hide show
  1. package/README.md +129 -127
  2. package/dist/godd.cjs +109 -90
  3. package/package.json +54 -54
package/README.md CHANGED
@@ -1,127 +1,129 @@
1
- # GoDD MCP α Server
2
-
3
- Cursor IDE 向けの AI プロンプト配信システム。MCP (Model Context Protocol) を通じて、プロジェクトの技術スタックに最適化されたプロンプト・マインドセット・エージェント定義を提供します。
4
-
5
- ## インストール
6
-
7
- ```bash
8
- npm install -g @autodevjapan/godd-mcp-alpha
9
- ```
10
-
11
- ## セットアップ（推奨）
12
-
13
- ```bash
14
- # Cursor IDE に MCP サーバーを登録（mcp.json を自動生成）
15
- godd install --license-key=YOUR_LICENSE_KEY
16
-
17
- # プロジェクトの config.godd を自動生成
18
- godd init
19
- ```
20
-
21
- > **`godd install` を使ってください。** mcp.json の手動編集は非推奨です。
22
- > `godd install` は起動コマンド・PATH・ライセンスキーを正しく設定します。
23
-
24
- ## mcp.json を手動で設定する場合
25
-
26
- `godd install` が使えない環境では、`~/.cursor/mcp.json` を直接編集できます。
27
- **`serve` 引数は必須です。** 省略するとインストーラーモードで起動し、MCP 通信が破綻します。
28
-
29
- ```json
30
- {
31
- "mcpServers": {
32
- "godd-mcp-alpha": {
33
- "command": "npx",
34
- "args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
35
- "env": {
36
- "GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
37
- }
38
- }
39
- }
40
- }
41
- ```
42
-
43
- ## 使い方
44
-
45
- インストール後、Cursor IDE を再起動すると GoDD MCP α サーバーが自動で起動します。
46
-
47
- Cursor のチャットで `/godd/godd_dev`、`/godd/godd_review` 等のコマンドを呼び出せます。
48
-
49
- ## GoDD プロンプト一覧
50
-
51
- Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一覧です。
52
-
53
- | プロンプト | 説明 |
54
- |---|---|
55
- | `godd_dev` | 開発（計画・実装・品質・テスト・ドキュメントを必ず実行） |
56
- | `godd_review` | レビュー（CTO レベルの多角的レビュー + 品質ゲート） |
57
- | `godd_ship` | 提出（適切な粒度でコミット → 品質チェック → プッシュ → PR 作成） |
58
- | `godd_test` | テスト実行/作成 |
59
- | `godd_docs` | ドキュメント生成/更新 |
60
- | `godd_impact` | 影響分析 |
61
- | `godd_setup` | 環境構築（推奨スタックプリセット付き・不足情報は確認） |
62
- | `godd_commit` | 変更をコミット |
63
- | `godd_push` | リモートにプッシュ |
64
- | `godd_pr` | PR 作成（テンプレート準拠） |
65
- | `godd_deploy` | デプロイ（検証・ロールバック計画付き） |
66
- | `godd_adr` | ADR（Architecture Decision Record）作成 |
67
- | `godd_release` | リリースノート生成（SemVer 準拠） |
68
- | `godd_github` | GitHub 設定（リポジトリ/ブランチ保護等） |
69
-
70
- ## CLI コマンド
71
-
72
- | コマンド | 説明 |
73
- |---|---|
74
- | `godd install [--license-key=KEY]` | Cursor に MCP サーバーを登録 |
75
- | `godd init [--force] [--lang=LANG]` | プロジェクトの config.godd を生成 |
76
- | `godd uninstall` | Cursor から MCP サーバーを削除 |
77
- | `godd serve` | MCP stdio サーバーを起動（Cursor が自動呼び出し） |
78
-
79
- ## ライセンスキーの取得
80
-
81
- GoDD MCP を利用するにはライセンスキーが必要です。以下の手順で取得できます。
82
-
83
- 1. [GoDD 公式サイト](https://www.getgodd.dev/pricing) でプランを確認
84
- 2. [アカウント登録](https://www.getgodd.dev/godd-admin/register) してサブスクリプションを購入
85
- 3. [ダッシュボード](https://www.getgodd.dev/godd-admin/dashboard) からライセンスキーを発行
86
-
87
- 発行されたライセンスキーを `godd install --license-key=YOUR_KEY` で設定してください。
88
-
89
- ## 動作要件
90
-
91
- - Node.js 22 以上
92
- - Cursor IDE
93
- - GoDD ライセンスキー（[公式サイト](https://www.getgodd.dev/pricing)で取得）
94
-
95
- ## トラブルシューティング
96
-
97
- ### 「利用可能なツールが 0 個」と表示される
98
-
99
- Cursor の MCP ログに以下のようなエラーが出ている場合:
100
-
101
- ```
102
- Unexpected end of JSON input
103
- Unexpected token 'G', "GoDD MCP α"... is not valid JSON
104
- ```
105
-
106
- **原因**: `mcp.json` の `args` に `"serve"` が含まれていません。`serve` なしで起動するとインストーラーモード（人間向けテキスト出力）になり、Cursor が期待する JSON-RPC 通信に失敗します。
107
-
108
- **対処法**:
109
-
110
- ```bash
111
- # 再インストールで mcp.json を正しく再生成
112
- npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
113
- ```
114
-
115
- その後 Cursor を再起動してください。
116
-
117
- ### ライセンスキーが別の端末に紐づいていると表示される
118
-
119
- GoDD のライセンスキーは端末（デバイス）に紐づきます。別端末で使用する場合は新しいライセンスキーを発行してください。
120
-
121
- ```bash
122
- godd install --license-key=NEW_LICENSE_KEY
123
- ```
124
-
125
- ## ライセンス
126
-
127
- Proprietary — GoDD ライセンスキーが必要です。[公式サイト](https://www.getgodd.dev/pricing)からご購入いただけます。
1
+ # GoDD MCP α Server
2
+
3
+ Cursor IDE 向けの AI プロンプト配信システム。MCP (Model Context Protocol) を通じて、プロジェクトの技術スタックに最適化されたプロンプト・マインドセット・エージェント定義を提供します。
4
+
5
+ ## インストール
6
+
7
+ ```bash
8
+ npm install -g @autodevjapan/godd-mcp-alpha
9
+ ```
10
+
11
+ ## セットアップ（推奨）
12
+
13
+ ```bash
14
+ # Cursor IDE に MCP サーバーを登録（mcp.json を自動生成）
15
+ godd install --license-key=YOUR_LICENSE_KEY
16
+
17
+ # プロジェクトの config.godd を自動生成
18
+ godd init
19
+ ```
20
+
21
+ > **`godd install` を使ってください。** mcp.json の手動編集は非推奨です。
22
+ > `godd install` は起動コマンド・PATH・ライセンスキーを正しく設定します。
23
+
24
+ ## mcp.json を手動で設定する場合
25
+
26
+ `godd install` が使えない環境では、`~/.cursor/mcp.json` を直接編集できます。
27
+ **`serve` 引数は必須です。** 省略するとインストーラーモードで起動し、MCP 通信が破綻します。
28
+
29
+ ```json
30
+ {
31
+ "mcpServers": {
32
+ "godd-mcp-alpha": {
33
+ "command": "npx",
34
+ "args": ["-y", "@autodevjapan/godd-mcp-alpha@latest", "serve"],
35
+ "env": {
36
+ "GODD_LICENSE_KEY": "GODD-XXXX-XXXX"
37
+ }
38
+ }
39
+ }
40
+ }
41
+ ```
42
+
43
+ ## 使い方
44
+
45
+ インストール後、Cursor IDE を再起動すると GoDD MCP α サーバーが自動で起動します。
46
+
47
+ Cursor のチャットで `/godd/godd_dev`、`/godd/godd_review` 等のコマンドを呼び出せます。
48
+
49
+ ## GoDD プロンプト一覧
50
+
51
+ Cursor IDE 上で利用できる GoDD プロンプト（MCP ツール）の一覧です。
52
+
53
+ | プロンプト | 説明 |
54
+ |---|---|
55
+ | `godd_dev` | 開発（計画・実装・品質・テスト・ドキュメントを必ず実行） |
56
+ | `godd_check` | 品質ゲート（Spec整合・テスト・型・Lint・セキュリティを検証） |
57
+ | `godd_docs` | ドキュメント生成/更新 |
58
+ | `godd_ship` | 提出（適切な粒度でコミット → 品質チェック → プッシュ → PR 作成） |
59
+ | `godd_setup` | 環境構築（推奨スタックプリセット付き・不足情報は確認） |
60
+ | `godd_review` | レビュー（CTO レベルの多角的レビュー + 品質ゲート） |
61
+ | `godd_test` | テスト実行/作成 |
62
+ | `godd_impact` | 影響分析 |
63
+ | `godd_commit` | 変更をコミット |
64
+ | `godd_push` | リモートにプッシュ |
65
+ | `godd_pr` | PR 作成（テンプレート準拠） |
66
+ | `godd_deploy` | デプロイ（検証・ロールバック計画付き） |
67
+ | `godd_adr` | ADR（Architecture Decision Record）作成 |
68
+ | `godd_release` | リリースノート生成（SemVer 準拠） |
69
+ | `godd_github` | GitHub 設定（リポジトリ/ブランチ保護等） |
70
+ | `godd_config` | config.godd を正確に生成・修正する（スタック自動検出 + バリデーション） |
71
+
72
+ ## CLI コマンド
73
+
74
+ | コマンド | 説明 |
75
+ |---|---|
76
+ | `godd install [--license-key=KEY]` | Cursor に MCP サーバーを登録 |
77
+ | `godd init [--force] [--lang=LANG]` | プロジェクトの config.godd を生成 |
78
+ | `godd uninstall` | Cursor から MCP サーバーを削除 |
79
+ | `godd serve` | MCP stdio サーバーを起動（Cursor が自動呼び出し） |
80
+
81
+ ## ライセンスキーの取得
82
+
83
+ GoDD MCP を利用するにはライセンスキーが必要です。以下の手順で取得できます。
84
+
85
+ 1. [GoDD 公式サイト](https://www.getgodd.dev/pricing) でプランを確認
86
+ 2. [アカウント登録](https://www.getgodd.dev/godd-admin/register) してサブスクリプションを購入
87
+ 3. [ダッシュボード](https://www.getgodd.dev/godd-admin/dashboard) からライセンスキーを発行
88
+
89
+ 発行されたライセンスキーを `godd install --license-key=YOUR_KEY` で設定してください。
90
+
91
+ ## 動作要件
92
+
93
+ - Node.js 22 以上
94
+ - Cursor IDE
95
+ - GoDD ライセンスキー（[公式サイト](https://www.getgodd.dev/pricing)で取得）
96
+
97
+ ## トラブルシューティング
98
+
99
+ ### 「利用可能なツールが 0 個」と表示される
100
+
101
+ Cursor の MCP ログに以下のようなエラーが出ている場合:
102
+
103
+ ```
104
+ Unexpected end of JSON input
105
+ Unexpected token 'G', "GoDD MCP α"... is not valid JSON
106
+ ```
107
+
108
+ **原因**: `mcp.json` の `args` に `"serve"` が含まれていません。`serve` なしで起動するとインストーラーモード（人間向けテキスト出力）になり、Cursor が期待する JSON-RPC 通信に失敗します。
109
+
110
+ **対処法**:
111
+
112
+ ```bash
113
+ # 再インストールで mcp.json を正しく再生成
114
+ npx -y @autodevjapan/godd-mcp-alpha install --license-key=YOUR_KEY
115
+ ```
116
+
117
+ その後 Cursor を再起動してください。
118
+
119
+ ### ライセンスキーが別の端末に紐づいていると表示される
120
+
121
+ GoDD のライセンスキーは端末（デバイス）に紐づきます。別端末で使用する場合は新しいライセンスキーを発行してください。
122
+
123
+ ```bash
124
+ godd install --license-key=NEW_LICENSE_KEY
125
+ ```
126
+
127
+ ## ライセンス
128
+
129
+ Proprietary — GoDD ライセンスキーが必要です。[公式サイト](https://www.getgodd.dev/pricing)からご購入いただけます。