@ripla/godd-mcp
v1.0.6
Published
GoDD MCP Server - AI-powered development workflow tools via Model Context Protocol (slash commands support)
Downloads
6,328
Keywords
Readme
GoDD MCP Server
GoDD(Governance-orchestrated Driven Development / 統治駆動開発) の方法論を、Cursor IDE のチャット AI に注入する MCP サーバーです。 追加の API キーは不要です。Cursor 搭載の AI がそのまま処理します。
必要なもの
| 項目 | 備考 |
|------|------|
| Node.js 20 以上 | node -v で確認 |
| Cursor IDE | 最新版推奨 |
| ライセンスキー | 管理者から受領 |
| Registry URL | 管理者から受領 |
セットアップ
Step 1: GoDD をインストールする
npm install -g @ripla/godd-mcpインストール後、以下でバージョンを確認できます:
godd versionグローバルインストールしたくない場合は、以降のコマンドを
npx @ripla/godd-mcp <command>で代替できます。 例:npx @ripla/godd-mcp init
Step 2: プロジェクトをセットアップする
GoDD を使いたいプロジェクトのディレクトリに移動し、godd init を実行します。
cd /path/to/your-project
godd init対話形式で以下を入力していきます:
- ライセンスキー — 管理者から受領したキーを入力
- 言語 —
ja(日本語)など - Registry URL — 管理者から指定された URL を入力
- 技術スタック — 使用する言語・フレームワーク・DB を選択
ライセンスキーを入力してください: godd-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
使用言語を選択 [ja/en/zh/ru/kz/tr] (default: ja): ja
Registry API URL (default: http://localhost:8100): https://godd-registry.example.com
【言語】
1. Python
2. TypeScript
3. JavaScript
...
選択 (例: 1,2): 1,2
【フロントエンド】
1. React
2. Next.js
...
選択 (例: 1): 1
【バックエンド】
1. FastAPI
2. Django
...
選択 (例: 1): 1完了すると、以下の 3 ファイルが自動生成されます:
| ファイル | 内容 |
|---------|------|
| config.godd | 技術スタックコンポーネントの設定 |
| .env | ライセンスキー・言語・Registry URL(GoDD 管理値) |
| .cursor/mcp.json | Cursor IDE への MCP サーバー登録 |
.envにはライセンスキーが含まれます。.gitignoreに追加してください。.env
Step 3: Cursor IDE を再起動する
設定後、Cursor IDE を再起動してください。
再起動後、Settings > MCP で godd サーバーのステータスが Running になっていれば完了です。
複数プロジェクトで使う場合
プロジェクトごとに godd init を実行するだけです。プロジェクト A は React + FastAPI、プロジェクト B は Vue + Django のように、それぞれ異なる構成にできます。GoDD の再インストールは不要です。
技術スタックを変更したい場合
プロジェクトディレクトリで godd init を再実行してください。コンポーネントは config.godd を直接編集することもできます。ライセンスキー・言語・Registry URL は .env の GODD_LICENSE_KEY / GODD_LANGUAGE / GODD_REGISTRY_URL を編集してください。Cursor のチャットで godd_config ツールを使って更新することもできます。変更後は Cursor IDE を再起動してください。
再実行時の既存設定保護:
config.goddや.envが既に存在する場合、godd initは現在の設定をデフォルト値として表示します。Enter を押すだけで既存設定を保持できます。コンポーネントを再選択したい場合は、コンポーネント引き継ぎの質問でnを入力してください。
バイナリ(ZIP)でのインストール
Node.js をインストールせずに使いたい場合は、スタンドアロンバイナリも利用できます。 管理者から受領した ZIP ファイルを展開し、以下を実行してください:
Windows:
.\godd.exe installmacOS / Linux:
chmod +x godd
./godd installmacOS で「開発元不明」の警告が出た場合は、先に以下を実行してください:
xattr -d com.apple.quarantine godd
GoDD CLI コマンド一覧
| コマンド | 短縮形 | 説明 |
|---------|--------|------|
| godd install | godd i | GoDD をシステムにインストール |
| godd init | — | プロジェクトのセットアップ(config.godd + .cursor/mcp.json 生成) |
| godd server | godd s | MCP サーバーを起動(Cursor が自動実行) |
| godd notes compose | godd n compose | GoDD Notes をローカル Docker Compose で起動(--auto で自動実行) |
| godd notes deploy | godd n deploy | GoDD Notes をクラウドにデプロイ(infra の provider に従う、-y で確認スキップ) |
| godd notes infra | godd n infra | notes-api/ / notes-app/ とクラウドインフラを対話形式で構築(AWS/GCP/Azure/Vercel×Railway) |
| godd notes status | godd n status | デプロイ状態・ヘルスチェックを確認 |
| godd version | godd v | バージョン表示 |
| godd help | godd h | ヘルプ表示 |
npx で実行する場合は
npx @ripla/godd-mcp <command>に置き換えてください。 例:npx @ripla/godd-mcp notes deploy -y
利用可能なツール(29 件)
Cursor のチャットで以下のツールが使えます。ツール名を指定しなくても、AI が自動的に適切なツールを選択します。 全ツールの入力は optional — 引数なしで呼び出し可能で、Chat の文脈から AI が自動補完します。
プライマリコマンド(厳選 6 個)
開発の基本ワークフローに必須のコマンド。
| ツール | 説明 | 呼び出し例 |
|--------|------|-----------|
| godd_dev | 開発ワークフローのメインエントリ。Spec 確認→影響調査→実装→品質ゲート→PR 本文生成まで一貫実行。デフォルトブランチ上では feat/<slug>-<YYYYMMDD> ブランチを自動作成 | 「ユーザー登録 API を実装して」 |
| godd_review | CTO レベルのコードレビュー。アーキテクチャ一貫性・スケーラビリティ・技術的負債・ビジネスインパクトの観点でフィードバック。重大度分類(CRITICAL/MAJOR/MINOR/SUGGESTION)付き | 「この PR をレビューして」 |
| godd_check | 品質チェック。Spec 整合・影響範囲・テスト計画・互換性・セキュリティの観点で提出前チェック | 「品質チェックして」 |
| godd_commit | 責務単位コミット。1 コミット = 1 責務で分割し、Conventional Commits 準拠のメッセージで実行 | 「コミットして」 |
| godd_submit | 提出一括実行。品質チェック → push → PR 作成を一括実行 | 「PR 出して」 |
| godd_notes_deploy | GoDD Notes のデプロイ案内(compose / deploy / infra) | 「Notes をデプロイして」 |
サブコマンド — Git 系
| ツール | 説明 |
|--------|------|
| godd_sync | main ブランチの最新を取り込み。コンフリクトは SSOT 準拠側を優先 |
| godd_new_branch | 変更を退避し、最新 main からブランチ作成して復元 |
| godd_git_workflow | sync → new-branch → commit を一括実行 |
| godd_push | 提出前チェック。品質ゲート・Spec 整合・機密情報チェック |
| godd_push_execute | 提出前チェック後に git push 実行 |
| godd_pr_create | 変更分析と PR テンプレート準拠の本文生成、GitHub 上で PR 作成 |
サブコマンド — 設計・仕様系
| ツール | 説明 |
|--------|------|
| godd_spec | 要求を仕様に変換。API/UI/DB/Feature/Usecase の粒度で Spec 化 |
| godd_impact | 影響分析。変更の影響範囲を洗い出し |
| godd_test_plan | テスト計画。unit/integration/e2e の必要性とテスト項目を策定 |
| godd_adr | ADR 作成。設計判断をトレードオフ・ロールバック含めて記録 |
サブコマンド — ドキュメント系
| ツール | 説明 |
|--------|------|
| godd_documentation | ドキュメント更新。Spec/README/設定説明/技術スタックの更新を洗い出し |
| godd_docs_init | docs/ フォルダ構造をテンプレートから生成 |
| godd_docs_update | コード変更に合わせて docs/ 内の関連ドキュメントを同期・更新 |
| godd_release_notes | リリースノート作成。変更点・互換性・既知の問題を整理 |
サブコマンド — 分析・変換系
| ツール | 説明 |
|--------|------|
| godd_pr_analyze | PR 分析。差分からレビュー観点・リスク・追加情報を整理 |
| godd_report | 完了報告。変更概要・影響範囲・検証結果・残リスクを整理 |
| godd_req_to_flow | 要求 → ビジネスフロー変換 |
| godd_req_to_tickets | 要求 → チケット分解 |
| godd_spec_to_tickets | 仕様 → チケット変換 |
サブコマンド — 環境・セットアップ系
| ツール | 説明 |
|--------|------|
| godd_setup | 環境構築。config.godd / .env / .cursor/mcp.json 生成、依存導入 |
| godd_config | 設定の表示・更新(components は config.godd、license_key 等は .env) |
| godd_install | ツール/MCP サーバーインストール案内 |
| godd_dev_workflow | 開発ワークフロー全体。環境構築→実装→テスト→コミット→PR |
スラッシュコマンドの使い方
Cursor のチャットで / を入力すると、GoDD の MCP ツールをスラッシュコマンドとして呼び出せます。
呼び出し方法
チャット入力欄で / を入力するとコマンド候補が表示されます。キーワードを続けて入力すると候補が絞り込まれます。
コマンド形式: /{サーバー名}/{ツール名}
godd init で生成される .cursor/mcp.json のサーバーキー名(デフォルト: godd)がプレフィックスになります。例えばサーバー名が godd なら /godd/dev、godd-a なら /godd-a/dev のように表示されます。
例 1: ツールを明示して依頼
/godd/dev ユーザー登録 API を実装して
例 2: 複数ツールの組み合わせ
/godd/spec この要件を仕様に変換して
例 3: ツールを指定しなくても AI が自動選択
コミットメッセージを作って
→ AI が自動的に godd_commit を選択ヒント: ツールを明示しなくても AI が自動的に最適なツールを選びます。特定のツールを確実に使いたい場合にスラッシュコマンドを活用してください。
スラッシュコマンド一覧(29 件)
| コマンド(サーバー名 godd の場合) | 用途 |
|--------------------------------------|------|
| /godd/dev | 開発ワークフロー(ブランチ自動管理・分割コミット付き) |
| /godd/review | CTO レベルコードレビュー |
| /godd/check | 品質チェック |
| /godd/commit | 責務分割コミット |
| /godd/submit | 提出一括実行(品質チェック→push→PR 作成) |
| /godd/notes_deploy | Notes デプロイ案内 |
| /godd/sync | デフォルトブランチ同期 |
| /godd/new_branch | ブランチ作成 |
| /godd/git_workflow | sync→branch→commit 一括 |
| /godd/push | 提出前チェック |
| /godd/push_execute | 提出前チェック+push 実行 |
| /godd/pr_create | PR 作成 |
| /godd/spec | 要求→仕様変換 |
| /godd/impact | 影響分析 |
| /godd/test_plan | テスト計画作成 |
| /godd/adr | ADR(設計判断記録)作成 |
| /godd/documentation | ドキュメント更新支援 |
| /godd/docs_init | docs/ フォルダ構造生成 |
| /godd/docs_update | docs/ ドキュメント同期 |
| /godd/release_notes | リリースノート作成 |
| /godd/pr_analyze | PR 分析 |
| /godd/report | 完了報告作成 |
| /godd/req_to_flow | 要求→ビジネスフロー変換 |
| /godd/req_to_tickets | 要求→チケット変換 |
| /godd/spec_to_tickets | 仕様→チケット変換 |
| /godd/setup | 環境構築・設定変更 |
| /godd/config | config.godd の表示・更新 |
| /godd/install | ツール・ライブラリのインストール支援 |
| /godd/dev_workflow | エージェント開発ワークフロー全体 |
エコシステムツールのガイダンス
godd init で選択した技術スタックに応じて、プロジェクトで使用するライブラリやフレームワーク(エコシステムツール)の利用ガイダンスが MCP リソースとして自動登録されます。AI はスタック設定に基づいてこのガイダンスを自動的にコンテキストへ注入します。
エコシステムツールの例(FastAPI + React 構成の場合)
| カテゴリ | ツール | 説明 | |---------|--------|------| | Frontend | Orval | OpenAPI クライアントコード自動生成 | | Frontend | TanStack Query | 非同期データフェッチング/キャッシュ管理 | | Frontend | Vite | 高速フロントエンドビルドツール | | Frontend | Storybook | UI コンポーネント開発/カタログ | | Backend | SQLModel | SQLAlchemy + Pydantic ORM | | Backend | Alembic | DB マイグレーション | | Backend | FastAPI Users | 認証/ユーザー管理 | | DevTool | Ruff | Python Linter / Formatter | | DevTool | uv | Python パッケージマネージャ | | DevTool | Biome | Linter / Formatter(JS/TS) | | Testing | Pytest | Python テストフレームワーク | | Testing | HTTPX | Python HTTP クライアント(テスト用) | | Testing | Playwright | E2E テストフレームワーク | | Infra | Docker Compose | マルチコンテナオーケストレーション | | Monitoring | Sentry | エラー追跡 / パフォーマンス監視 |
注: 表示されるエコシステムツールは、
godd initで選択した技術スタック(コンポーネント)によって変わります。
自動 vs 手動
| モード | 動作 | いつ使う |
|--------|------|---------|
| 自動 | ツール名を指定せず依頼すると、AI が最適な MCP ツールを自動選択。エコシステムツールのガイダンスもスタック設定に基づいて自動注入される | 通常の開発作業 |
| 手動 | / でスラッシュコマンドを明示指定 | 特定のツールを確実に使いたい場合、複数ツールを組み合わせたい場合 |
トラブルシューティング
godd コマンドが見つからない
npm グローバルインストールの場合:
npm install -g @ripla/godd-mcpバイナリの場合は godd install を再実行し、ターミナルを再起動してください。
MCP サーバーが起動しない
godd versionが動くか確認.cursor/mcp.jsonのenv.GODD_CONFIGが正しいパスを指しているか確認config.goddが指定パスに存在するか確認- 手動でサーバーを起動してエラーを確認:
Windows:
set GODD_CONFIG=C:\path\to\your-project\config.godd
godd servermacOS / Linux:
GODD_CONFIG=/path/to/your-project/config.godd godd serverライセンスエラー
| エラー | 対処 |
|--------|------|
| Invalid license key | .env の GODD_LICENSE_KEY が正しいか確認 |
| Registry 発行のライセンスキーは Registry API で検証してください | components と registry_url を設定し、Registry API に接続できる状態で起動 |
| License has expired | 管理者に更新を依頼 |
Registry に接続できない
.envのGODD_REGISTRY_URLが正しいか確認- ネットワーク接続を確認
godd-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx形式の Registry 発行キーは、旧stack_profileのローカル署名検証では利用できません。componentsを設定した Registry モードで利用してください。
初回接続後は 10 時間のローカルキャッシュが有効です。キャッシュ期間中はオフラインでも動作します。
古いバージョンが動いている
godd version の出力が期待と異なる場合、古いバイナリが PATH に残っている可能性があります:
# npm で最新版に更新
npm install -g @ripla/godd-mcp
# バージョン確認
godd versionNotes のクラウドデプロイで pnpm 10+ 関連のエラーが出る場合は、@latest ではなく canary を明示して更新してください(後述の「esbuild の build script が拒否される」参照)。
GoDD Notes ライフサイクル
GoDD Notes は GoDD のドキュメント閲覧・編集 Web アプリです。以下のステップで構築・デプロイします。
1. GoDD をインストール
npm install -g @ripla/godd-mcpNotes をクラウドデプロイする場合(ローカルに pnpm 10+ がある環境)は、pnpm 10+ 向けの Notes App ビルド対応が @latest に含まれるまで canary の利用を推奨します:
npm install -g @ripla/godd-mcp@canary
godd version # 1.0.4-canary.20 以上であることを確認2. プロジェクトで godd init
cd /path/to/your-project
godd initプロジェクトごとに実行が必要です(2人目以降のメンバーも各自実行)。
3. クラウドインフラ構築(初回のみ)
godd notes infra対話形式で AWS リージョンや環境名を入力すると、以下が生成されます:
godd-notes/ディレクトリ内のnotes-api/,notes-app/(既存ディレクトリも同梱ソースで上書き更新し、.env/node_modules/distなどは除外)notes-app/pnpm-workspace.yaml(pnpm 10+ 向けallowBuild: esbuildを同梱)- Terraform ファイル(VPC, ECS, RDS, S3, CloudFront 等)
- CI/CD ワークフロー
チームで1人が実行すれば OK です。
既存環境で旧ブランド名の出力先や設定ファイルを生成済みの場合は、
godd notes infra を再実行して godd-notes/ と .godd-notes-*.json を再生成してください。
4. デプロイ
godd notes deploy # 対話形式
godd notes deploy -y # 確認スキップ(CI 向け).godd-notes-infra.json の provider(AWS / GCP / Azure / Vercel×Railway)に応じて、ローカルの notes-api と notes-app をクラウドにデプロイします。
notes-api が GitHub の main ブランチから docs/ を読んで Notes に展開します。
pnpm 10+ について: 1.0.4-canary.20 以降の CLI では、Notes App ビルド前に pnpm install --ignore-scripts(node_modules が無い場合のみ)と pnpm rebuild esbuild を自動実行します。pnpm approve-builds を手動で実行する必要はありません。
godd notes deploy実行時に@ripla/godd-mcpの新しいバージョンが利用可能な場合、警告が表示されます。
Notes デプロイで esbuild の build script が拒否される
pnpm 10+ で [ERR_PNPM_IGNORED_BUILDS] Ignored build scripts: esbuild や pnpm install 失敗が出る場合:
- CLI を更新する:
npm install -g @ripla/godd-mcp@canary(1.0.4-canary.20以降) notes-appを再 scaffold する: プロジェクトでgodd notes infraを再実行(pnpm-workspace.yamlを含む同梱ソースで上書き更新)- 再デプロイする:
godd notes deploy -y
ローカルで notes-app を直接ビルドする場合は、同梱の notes-app/README.md を参照してください。
ローカル開発(Docker Compose)
godd notes composeDocker Compose でローカルに Notes 環境を立ち上げます。
リリース(npm publish)
canary リリース(自動 / 手動 ref 指定)
main ブランチに godd-mcp-server/ または notes/ 配下の変更がマージされると、GitHub Actions(「Publish npm (auto on main push / canary)」)が自動で canary バージョンを publish します。
- バージョン形式:
v0.1.3-canary.1(本番最新タグの次 patch + canary 連番) - npm タグ:
canary(npm install @ripla/godd-mcp@canaryでインストール可能) - GitHub Release は作成しない(git tag のみ)
- 手動実行も可能(#1099): Actions タブから
ref入力に対象ブランチ/タグを指定して dispatch(bump コミットなし・canary タグのみ作成。dev デプロイと downstream 通知はdeploy_dev入力で制御)
本番リリース(本番タグ作成 → タグ指定 publish)
旧「Release GoDD MCP Server (latest / manual)」は #1099 で廃止されました。本番リリースは次の 2 ステップです:
- main の対象コミットに本番タグ(例:
v1.0.3。patch/minor/majorは PM が判断)を作成して push - Actions タブから「Publish npm (by tag / manual)」を
tag=v1.0.3で手動実行(dist-tag はタグ名から自動でlatestと判定) - GitHub Release は別途手動で作成(リリース前に差分確認が可能)
前提条件
GitHub リポジトリの Settings > Secrets and variables > Actions に以下を設定:
| Secret 名 | 値 |
|------------|-----|
| NPM_TOKEN | npmjs.com のアクセストークン(Automation タイプ推奨) |
