Neon Automation
NeonのサーバーレスPostgresワークフローを自動化 – プロジェクトやブランチの一覧表示、データベースの確認、接続URIの取得、ロール管理、およびNeonデータベース操作をクロスアプリパイプラインに統合します。
ツールキットドキュメント: composio.dev/toolkits/neon
セットアップ
- Composio MCPサーバーをクライアントに追加:
https://rube.app/mcp - プロンプトに従ってNeonアカウントを接続(APIキー認証)
- 以下のワークフローを使い始める
コアワークフロー
1. プロジェクト一覧の取得
NEON_RETRIEVE_PROJECTS_LIST を使用して、認証されたユーザーに関連するすべてのプロジェクトを検出します。
Tool: NEON_RETRIEVE_PROJECTS_LIST
Inputs:
- org_id: string (必須 – 個人APIキー使用時)
- limit: integer (1-400、デフォルト10)
- cursor: string (前回のレスポンスからのページネーションカーソル)
- search: string (プロジェクト名またはIDで検索、部分一致対応)
- timeout: integer (ミリ秒; タイムアウト時に部分結果を返す)
重要: 個人APIキーを使用する場合、org_id は必須です。最初に NEON_GET_USER_ORGANIZATIONS で取得してください。
2. プロジェクト詳細の取得
NEON_ACCESS_PROJECT_DETAILS_BY_ID を使用して、プロジェクト設定、所有者情報、消費メトリクスを確認します。
Tool: NEON_ACCESS_PROJECT_DETAILS_BY_ID
Inputs:
- project_id: string (必須) -- 形式: "形容詞-名詞-数字"、例 "dry-smoke-26258271"
3. プロジェクトのブランチ一覧
NEON_GET_BRANCHES_FOR_PROJECT を使用して、プロジェクト内のブランチ(開発ステージ)を列挙します。
Tool: NEON_GET_BRANCHES_FOR_PROJECT
Inputs:
- project_id: string (必須)
- search: string (オプション、ブランチ名またはIDで検索)
4. ブランチ上のデータベース一覧
NEON_FETCH_DATABASE_FOR_BRANCH を使用して、特定のプロジェクトとブランチ内のデータベースを一覧表示します。
Tool: NEON_FETCH_DATABASE_FOR_BRANCH
Inputs:
- project_id: string (必須)
- branch_id: string (必須)
5. 接続URIの取得
NEON_GET_PROJECT_CONNECTION_URI を使用して、プロジェクト/ブランチ/データベースのPostgres接続文字列を取得します。
Tool: NEON_GET_PROJECT_CONNECTION_URI
Inputs:
- project_id: string (必須)
- database_name: string (必須) -- 例 "neondb"
- role_name: string (必須) -- 例 "neondb_owner"
- branch_id: string (オプション、デフォルトはプロジェクトのデフォルトブランチ)
- endpoint_id: string (オプション、デフォルトは読み書きエンドポイント)
- pooled: boolean (オプション、追加で -pooler を使用してコネクションプーリング)
セキュリティ: 返されるURIには認証情報が含まれています。機密情報として扱い、ログや共有は絶対に行わないでください。
6. データベース詳細とロールの確認
NEON_RETRIEVE_BRANCH_DATABASE_DETAILS を使用してデータベースの接続前確認を行い、NEON_GET_BRANCH_ROLES_FOR_PROJECT で利用可能なロールを一覧表示します。
Tool: NEON_RETRIEVE_BRANCH_DATABASE_DETAILS
Inputs:
- project_id: string (必須)
- branch_id: string (必須)
- database_name: string (必須)
Tool: NEON_GET_BRANCH_ROLES_FOR_PROJECT
Inputs:
- project_id: string (必須)
- branch_id: string (必須)
既知の落とし穴
| 落とし穴 | 詳細 |
|---|---|
| org_id 必須 | 個人APIキー使用時に NEON_RETRIEVE_PROJECTS_LIST を実行するとHTTP 400「org_id is required」が返ります。最初に NEON_GET_USER_ORGANIZATIONS を呼び出してください。 |
| ページネーション不完全 | ページネーションを行わないとプロジェクト一覧が不完全になる場合があります。cursor が空になるまで繰り返し実行してください。 |
| レート制限 | NEON_RETRIEVE_PROJECTS_LIST はバースト的な一覧取得時にHTTP 429を返すことがあります。重複呼び出しを避け、リトライ前にバックオフを行ってください。 |
| 無効なロール/データベースの組み合わせ | NEON_GET_PROJECT_CONNECTION_URI は、database_name と role_name の組み合わせが無効な場合に401/403を返します。NEON_GET_BRANCH_ROLES_FOR_PROJECT を使用して許可されたロールを選択してください。 |
| 接続URIは機密情報 | 返されるURIには認証情報が含まれます。プレーンテキストでのログ、表示、共有は絶対に行わないでください。 |
クイックリファレンス
| ツールスラッグ | 説明 |
|---|---|
NEON_RETRIEVE_PROJECTS_LIST | すべてのNeonプロジェクトをページネーションと検索付きで一覧表示 |
NEON_ACCESS_PROJECT_DETAILS_BY_ID | プロジェクト設定と消費メトリクスを取得 |
NEON_GET_BRANCHES_FOR_PROJECT | プロジェクト内のブランチを一覧表示 |
NEON_FETCH_DATABASE_FOR_BRANCH | 特定のブランチ上のデータベースを一覧表示 |
NEON_GET_PROJECT_CONNECTION_URI | Postgres接続URI(認証情報含む)を取得 |
NEON_RETRIEVE_BRANCH_DATABASE_DETAILS | データベースのメタデータと設定を確認 |
NEON_GET_USER_ORGANIZATIONS | 認証されたユーザーの組織を一覧表示 |
NEON_CREATE_API_KEY_FOR_ORGANIZATION | 組織用の新しいAPIキーを作成 |
NEON_GET_BRANCH_ROLES_FOR_PROJECT | ブランチで利用可能なロールを一覧表示 |
Powered by Composio