Planetscale MCP Server

PlanetScale CLI

PlanetScale 不仅仅是一个数据库，我们的 CLI 也不只是一堆命令。pscale 命令行工具让你轻松使用分支、部署请求和其他 PlanetScale 概念。

安装

macOS

pscale 可通过 Homebrew Tap 安装，也可以从发布页面下载二进制文件：

brew install planetscale/tap/pscale

可选：某些命令需要在 PATH 中安装 MySQL 8 Client 才能运行 pscale。你可以运行以下命令安装：

brew install [email protected]

若要升级到最新版本：

brew upgrade pscale

Linux

pscale 可从发布页面下载二进制文件。从发布页面下载 .deb 或 .rpm 文件，然后分别使用 sudo dpkg -i 和 sudo rpm -i 安装。

Arch：pscale-cli-bin

Windows

pscale 可通过 scoop 安装，也可以从发布页面下载二进制文件：

scoop bucket add pscale https://github.com/planetscale/scoop-bucket.git
scoop install pscale mysql

若要升级到最新版本：

scoop update pscale

手动安装

从发布页面下载预编译的二进制文件，并复制到所需位置。

也可以安装 bin，它适用于所有 macOS、Windows 和 Linux 平台：

bin install https://github.com/planetscale/cli

若要升级到最新版本

bin upgrade pscale

容器镜像

我们提供开箱即用的 Docker 容器镜像。拉取最新镜像：

docker pull planetscale/pscale:latest

拉取指定版本：

docker pull planetscale/pscale:v0.63.0

如果你想创建一个 shell 别名，让你每次输入 pscale 时都通过 docker 运行最新版本的 pscale：

mkdir -p $HOME/.config/planetscale
alias pscale="docker run -e HOME=/tmp -v $HOME/.config/planetscale:/tmp/.config/planetscale --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp planetscale/pscale:latest"

如果你需要更高级的示例，能够使用服务令牌，并区分需要伪终端或非交互模式的命令，请参阅此 shell 函数。

MCP 服务集成

使用托管的 PlanetScale MCP 服务：https://planetscale.com/docs/connect/mcp

GitHub Actions 用法

使用 setup-pscale-action 在 GitHub Actions 中安装并使用 pscale。

- name: Setup pscale
  uses: planetscale/setup-pscale-action@v1
- name: Use pscale
  env:
    PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
    PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
  run: |
    pscale deploy-request list my-db --org my-org

本地开发

运行命令：

go run cmd/pscale/main.go <command>

或者，你可以构建 pscale：

go build cmd/pscale/main.go

然后使用在 cmd/pscale/ 中构建的 pscale 二进制文件进行测试：

./cmd/pscale/pscale <command>

API 客户端位于 internal/planetscale/；此仓库不再依赖 planetscale-go。修改面向 API 的代码前，请阅读 doc/api-client.md。

文档

请查看我们的文档页面：planetscale.com/docs

对于 AI Agent 和自动化任务，运行 pscale agent-guide（或运行 pscale --skill 获取可安装的技能文件）——请参阅 AGENTS.md。 对于运维工作流（清单、安全审查、架构建议），请安装 planetscale/skills。