planetscale/mcp

分类Database
作者Community
星标468
定价Free

简介

planetscale/mcp 是一个将 PlanetScale 数据库能力直接接入 AI 客户端的协议实现。它让 LLM 能够通过标准接口安全地访问你的数据库模式、查询数据或执行管理操作,而无需你手动导出 Schema 或复制 SQL 结果给 AI。对于开发者而言,这相当于给 AI 助手安装了一个数据库插件,使其能基于实时数据提供更精准的代码建议或分析报告。由于集成在 PlanetScale CLI 中,只要你有基础的命令行操作经验,配置起来非常快速,能显著提升数据库运维和开发调试的效率。

核心亮点

  • 实现 AI 对 PlanetScale 数据库的实时访问
  • 无需手动同步 Schema,AI 自动感知表结构
  • 通过标准 MCP 协议快速集成至 AI 客户端
  • 简化数据库查询与分析的交互流程

完整文档

PlanetScale CLI ![Build status](https://github.com/planetscale/cli/actions/workflows/ci.yml)

PlanetScale 不仅仅是一个数据库,我们的 CLI 也不仅仅是命令的堆砌。pscale 命令行工具让您能够随手操作 branches、deploy requests 以及其他 PlanetScale 概念。

!PlanetScale CLI

Installation

#### macOS

pscale 可通过 Homebrew Tap 安装,也可从 releases 页面下载二进制文件:

code
brew install planetscale/tap/pscale
可选:pscale 在执行某些命令时要求 PATH 中包含 MySQL 8 Client。你可以通过运行以下命令进行安装:
code
brew install [email protected]
升级到最新版本:
code
brew upgrade pscale
#### Linux

pscale 可在 releases 页面下载二进制文件。请从 releases 页面下载 .deb 或 .rpm 文件,并分别使用 sudo dpkg -isudo rpm -i 进行安装。

Arch: pscale-cli-bin

#### Windows

pscale 可通过 scoop 安装,也可从 releases 页面下载二进制文件:

code
scoop bucket add pscale https://github.com/planetscale/scoop-bucket.git
scoop install pscale mysql
升级到最新版本:
code
scoop update pscale
#### 手动安装

releases 页面下载预编译的二进制文件,并将其复制到所需位置。

或者,你可以安装适用于所有 macOSWindowsLinux 平台的 bin

code
bin install https://github.com/planetscale/cli
升级到最新版本
code
bin upgrade pscale
#### 容器镜像

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

code
docker pull planetscale/pscale:latest
若要拉取特定版本:
code
docker pull planetscale/pscale:v0.63.0
如果你希望在输入 pscale 时,通过 docker 运行最新版本的 pscale shell 别名:
code
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"
如果您需要一个更高级的示例,能够支持 service tokens 并区分需要伪终端(pseudo terminal)或非交互模式的命令,请查看这个 shell 函数

MCP Server 集成

> 已弃用: 基于 CLI 的 MCP server (pscale mcp) 已弃用,并将在未来版本中移除。请改用 PlanetScale MCP server:https://planetscale.com/docs/connect/mcp

GitHub Actions 用法

在 GitHub Actions 中,请使用 setup-pscale-action 来安装并使用 pscale
yaml
- 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
## 本地开发

要运行命令:

code
go run cmd/pscale/main.go <command>
或者,你可以构建 pscale
code
go build cmd/pscale/main.go
然后使用在 cmd/pscale/ 中构建的 pscale 二进制文件进行测试:
code
./cmd/pscale/pscale <command>
## 文档

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

对于 AI agent 和自动化,请运行 pscale agent-guide 或参阅 AGENTS.md
对于运维工作流(资产盘点、安全审查、schema 建议),请安装 planetscale/skills