使用说明

项目简介

Neon MCP Server 是一个轻量级的 Model Context Protocol (MCP) 服务器,它基于 Cloudflare Workers 平台构建,并集成了 Neon REST API。该服务器旨在为 LLM 客户端(如 Cursor 编辑器)提供与 Neon 数据库平台交互的工具,实现项目和分支的管理功能。

主要功能点

  • 项目管理: 列出 Neon 平台上的所有项目。
  • 分支管理:
    • 列出指定项目的所有分支。
    • 获取指定分支的详细信息。
    • 删除指定分支。
    • 恢复分支到指定时间点或 LSN。
    • 比较不同分支之间的数据库 Schema。
    • 获取指定数据库的 Schema 定义。
    • 列出指定分支上的所有数据库。

安装步骤

  1. 克隆仓库并部署到 Cloudflare: 运行以下命令,使用 'create-mcp' 工具克隆仓库并部署到您的 Cloudflare 账户:
    bun create mcp --clone https://github.com/zueai/neon-mcp
  2. 配置 Cursor MCP 服务器: 打开 Cursor 编辑器的设置,找到 "MCP" -> "Add new MCP server",粘贴安装步骤 1 完成后复制到剪贴板的命令。
  3. 上传 Neon API 密钥: 将您的 Neon API 密钥上传到 Cloudflare Worker 的 Secrets 中:
    bunx wrangler secret put NEON_API_KEY

服务器配置

MCP 客户端(如 Cursor)需要配置以下信息以连接到 Neon MCP Server:

{
  "serverName": "Neon MCP Server",
  "command": "wrangler",
  "args": ["dev", "--remote", "--persist"]
}

参数注释:

  • 'serverName': MCP 服务器的名称,可以自定义,用于在客户端中标识服务器。
  • 'command': 启动 MCP 服务器的命令,这里使用 'wrangler',Cloudflare Worker 的 CLI 工具。
  • 'args': 传递给 'wrangler' 命令的参数:
    • 'dev': 以开发模式启动 Worker,方便本地调试。
    • '--remote': 连接到远程 Cloudflare Worker 环境。
    • '--persist': 在本地持久化 Worker 的状态(如果需要)。

注意: 实际部署后,Cursor 配置中可能不需要 'command' 和 'args',而是直接使用 Cloudflare Worker 的 URL。 请根据 'create-mcp' 工具生成的实际部署指示进行配置。 上面的配置适用于本地开发和测试环境。

基本使用方法

  1. 在 Cursor 编辑器中配置并连接到 Neon MCP Server。
  2. 在 Cursor 中,您可以使用集成的 MCP 功能,通过工具列表访问 Neon MCP Server 提供的各项功能,例如列出项目、分支、数据库等。
  3. 根据 Cursor 的界面提示操作,即可调用 Neon API 提供的各种数据库管理功能。

信息

分类

数据库与文件