mcpField
P
planetscale-pscale-cli-automation

planetscale-pscale-cli-automation

github.com/planetscale数据与数据库1361.7k 次安装8 周前更新
代码仓库

关于 planetscale-pscale-cli-automation

面向编码 Agent 和 Shell 自动化的技能，说明如何非交互式调用 PlanetScale CLI，包括 JSON 输出、认证检查和标志位置。内容聚焦 CLI 约定，不涵盖数据库操作流程。

主要功能

  1. 01以 JSON 为主的 CLI 约定
  2. 02认证初始化步骤
  3. 03资源子命令的标志位置
  4. 04SQL 调用与角色说明
  5. 05破坏性命令的审批规则

适用场景

  1. 01在 Shell 脚本中自动执行 PlanetScale 检查
  2. 02指导编码 Agent 完成 CLI 认证
  3. 03无需交互式 Shell 执行数据库查询

MCP 相关

对于 MCP 客户端，该技能指向托管的 PlanetScale MCP 服务及其当前 URL。Shell 脚本和编码 Agent 则应使用带 JSON 输出的 `pscale`。

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/planetscale-pscale-cli-automation确认已加载。

详细介绍

PlanetScale CLI 自动化

目的

教会 Agent 如何以非交互方式调用 pscale。此技能仅涵盖 CLI 约定。运维工作流（盘点、安全审查、架构建议）请使用此仓库中的其他技能——完整评估请从 ../planetscale-safe-orchestrator/SKILL.md 开始。

两个 AGENTS.md 文件（请勿混淆）

文档位置用途
CLI Agent 指南随 pscale 一同提供（CLI 仓库中的 AGENTS.md，或 pscale agent-guide）如何调用 pscale：身份验证、--format json、标志位置、pscale sql
项目 Agent 指南应用仓库中的 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 sql，不要使用 pscale shell（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 数据库才传入 --keyspace。

MCP 与 CLI

  • MCP 客户端——使用托管的 PlanetScale MCP 服务（当前 URL 请参见 pscale agent-guide --format json）。
  • Shell 脚本和编码 Agent——如上所述，使用带 --format json 的 pscale。

此技能不够用时

安装完整的 PlanetScale 技能包（如果尚未安装）：

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

然后运行子技能，或使用 ../planetscale-safe-orchestrator/SKILL.md 执行超出基本 CLI 调用范围的数据库操作。

当前约定的权威来源

优先采用实时输出，而不是依赖记忆中的标志语法：

pscale agent-guide --format json

内嵌的 guide 字段包含随 pscale 二进制文件提供的完整 CLI Agent 指南。

评论

支持 Markdown