项目简介

PlanetScale CLI 集成了 Model Context Protocol (MCP) 服务器,旨在为 AI 工具提供直接访问 PlanetScale 数据库的标准化接口。通过 MCP 服务器,AI 助手可以安全、便捷地获取 PlanetScale 数据库的上下文信息,并执行相关操作。

主要功能点

  • 资源管理: 提供对 PlanetScale 组织、数据库、分支、Keyspace、表等资源的管理和访问能力。
  • 数据访问: 允许 AI 工具执行只读 SQL 查询,获取数据库信息。
  • 工具注册与执行: 虽然当前仓库信息未明确列出自定义 Tool 的注册,但 MCP Server 的架构设计支持未来扩展自定义 Tool 功能。
  • Prompt 模板: 仓库信息未明确提及 Prompt 模板,但 MCP Server 的设计理念支持 Prompt 模板的定义和渲染,以便定制 LLM 交互模式 (根据仓库信息,此功能可能未在此仓库中直接实现,但 MCP 协议本身支持)。
  • 安全认证: 通过 PlanetScale CLI 的认证机制,MCP 服务器可以安全地验证 AI 工具的访问权限。

安装步骤

PlanetScale CLI 提供了多种安装方式,您可以根据您的操作系统选择合适的方式进行安装。详细安装步骤请参考 PlanetScale CLI 官方文档

常用安装方式:

  • macOS: 使用 Homebrew 安装

    brew install planetscale/tap/pscale
  • Linux:GitHub Releases 页面 下载二进制文件安装。

  • Windows: 使用 scoop 安装

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

服务器配置

MCP 客户端(如 Claude Desktop, Cursor Editor 或其他支持自定义 MCP 服务器的 AI 工具)需要配置 PlanetScale MCP 服务器的启动命令和参数。以下是通用的 JSON 配置信息示例,请根据您的 AI 工具进行配置:

{
  "mcpServers": {
    "planetscale": {
      "command": "pscale",
      "args": ["mcp", "server"]
    }
  }
}

配置参数说明:

  • server name: 'planetscale' (服务器名称,可以自定义)
  • command: 'pscale' (PlanetScale CLI 的可执行命令)
  • args: '["mcp", "server"]' (启动 MCP 服务器的子命令和参数)

基本使用方法

  1. 安装 PlanetScale CLI: 根据上述安装步骤安装 'pscale' 命令行工具。

  2. 配置 AI 工具: 在您的 AI 工具中,找到 MCP 服务器配置选项,并添加上述 JSON 配置信息。

  3. 启动 AI 工具: 重启您的 AI 工具,使配置生效。

  4. 使用 AI 工具与 PlanetScale 数据库交互: 在 AI 工具中,您可以指示 AI 助手执行与 PlanetScale 数据库相关的操作,例如:

    • “列出我的 PlanetScale 数据库”
    • “展示数据库 'mydatabase' 的分支”
    • “查询数据库 'mydatabase' 分支 'main' 中表 'mytable' 的 Schema”
    • “查询数据库 'mydatabase' 分支 'main' 中表 'mytable' 的数据” (仅限只读查询)

    AI 工具将通过 MCP 服务器与您的 PlanetScale 数据库进行交互,并返回结果。

信息

分类

数据库与文件