mcpField
P
planetscale-pscale-cli-automation

planetscale-pscale-cli-automation

github.com/planetscaleデータ・データベース1361.7k 回インストール8 週間前に更新
リポジトリ

planetscale-pscale-cli-automation について

コーディングエージェントやシェル自動化向けに、PlanetScale CLIを非対話形式で使う方法をまとめたスキルです。JSON出力や認証確認、フラグの配置を扱い、データベース操作手順ではなくCLIの規約に焦点を当てています。

主な機能

  1. 01JSONを基本とするCLI規約
  2. 02認証の初期確認手順
  3. 03リソースコマンドのフラグ配置
  4. 04SQL実行とロールの説明
  5. 05破壊的操作の承認ルール

活用シーン

  1. 01シェルスクリプトでのPlanetScale確認の自動化
  2. 02CLI認証を行うコーディングエージェントのガイド
  3. 03対話型シェルを使わないデータベースクエリ

MCP 対応

MCPクライアントには、ホスト型PlanetScale MCPサーバーと最新URLを案内します。シェルスクリプトやコーディングエージェントには、JSON出力を指定した `pscale` の利用を勧めています。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/planetscale/skills --skill planetscale-pscale-cli-automation

インストール後、Claude Code で/planetscale-pscale-cli-automationを入力して読み込まれたか確認します。

詳細

PlanetScale CLI の自動化

目的

エージェントに pscale を非対話的に呼び出す方法を教えます。このスキルで扱うのは CLI の規約のみ です。運用ワークフロー（インベントリ、安全性レビュー、スキーマの推奨事項）には、このリポジトリ内のほかのスキルを使用します。全体的な評価を行うには、まず ../planetscale-safe-orchestrator/SKILL.md を参照してください。

2 つの AGENTS.md ファイル（混同しないでください）

ドキュメント場所目的
CLI エージェントガイドpscale に同梱（CLI リポジトリ内の AGENTS.md、または pscale agent-guide）pscale の呼び出し方法：認証、--format json、フラグの配置、pscale sql
プロジェクトエージェントガイドアプリケーションリポジトリの AGENTS.md対象の組織、データベース、ブランチ、エンジン、本番ブランチ、MCP のスコープ、承認ルール

オペレーターの承認なしにプロジェクトの AGENTS.md を編集しないでください（../planetscale-mcp-agent-operating-model/SKILL.md を参照）。

初期設定（必ずここから開始）

pscale agent-guide --format json
pscale auth check --format json

auth check が "status": "action_required" を返す場合は、JSON 内の issues と next_steps に従ってください。ログインには、人間によるブラウザーでの承認が必要な場合があります。pscale auth login --format json を使用してください。

規約

  • 自動化では必ず --format json を指定してください。
  • リソースのサブコマンド（database、branch、sql、api など）には --org <org> を指定します。ルートの pscale には指定しません。
  • 位置引数はフラグより前に指定します（pscale sql mydb main --org bb …）。
  • pscale shell ではなく pscale sql を使用してください（shell には TTY が必要です）。
  • デフォルトの SQL ロールは reader です。書き込みには --role admin（または writer/readwriter）を指定してください。--role と --replica の動作は pscale shell のセマンティクスに合わせてください。
  • --force はサブコマンドごとに指定します（例：database delete … --force、pscale sql … --force）。グローバルな --force や PSCALE_FORCE はありません。
  • --format json を指定しただけでは確認は省略されません。明示的なユーザー承認を得た後、破壊的なサブコマンドに --force を追加してください。

一般的なワークフロー

pscale auth check --format json
pscale org list --format json
pscale database list --org <org> --format json
pscale branch list <database> --org <org> --format json
pscale sql <database> <branch> --org <org> --format json --query "SELECT 1"

MySQL ではデフォルトで @primary が使用されます（pscale shell と同じです）。マルチキースペースデータベースの場合にのみ --keyspace を指定してください。

MCP と CLI

  • MCP クライアント — ホスト型の PlanetScale MCP サーバーを使用します（現在の URL は pscale agent-guide --format json を参照してください）。
  • シェルスクリプトとコーディングエージェント — 上記のとおり、--format json を指定して pscale を使用します。

このスキルで足りない場合

（まだインストールしていない場合は）PlanetScale スキルパック全体をインストールします。

git clone https://github.com/planetscale/skills.git && cd skills && script/setup
# or: npx skills add planetscale/skills -g -y

基本的な CLI 呼び出しを超えるデータベース操作には、サブスキルまたは ../planetscale-safe-orchestrator/SKILL.md を実行してください。

現在の規約の信頼できる情報源

記憶したフラグの構文より、最新の出力を優先してください。

pscale agent-guide --format json

埋め込みの guide フィールドには、pscale バイナリに同梱された CLI エージェントガイドの全文が含まれています。

コメント

Markdown 対応