项目简介

Neon MCP 服务器是一个基于 Model Context Protocol (MCP) 实现的应用后端，专为与 Neon 数据库服务集成而设计。它将 Neon REST API 的功能封装为 MCP 工具，使得支持 MCP 协议的 LLM 客户端（如 Cursor）能够直接与您的 Neon 数据库项目进行交互，执行数据库管理和查询相关的操作。

主要功能点

该服务器提供了以下核心功能作为可供LLM调用的工具：

• 项目管理: 列出您的所有 Neon 项目。
• 分支管理: 列出指定项目下的所有数据库分支，获取特定分支的详细信息，以及执行删除和恢复分支的操作。
• 数据库管理: 列出指定分支下的所有数据库。
• 结构 (Schema) 操作: 获取指定数据库在特定分支、LSN (Log Sequence Number) 或时间点下的 SQL 结构定义；比较两个分支或时间点之间的数据库结构差异。

安装步骤

本项目主要通过 Cloudflare Workers 部署。推荐使用 'bun' 包管理器进行安装和部署：

1. 运行自动化安装脚本。这个脚本会克隆本仓库，引导您完成 Cloudflare Workers 的部署过程，并将客户端所需的启动命令复制到剪贴板。

   bun create mcp --clone https://github.com/zueai/neon-mcp
   

2. 将您的 Neon API Key 配置到 Cloudflare Workers 的 Secrets 中。在终端运行以下命令，然后输入您的 API Key：

   bunx wrangler secret put NEON_API_KEY
   

服务器配置 (针对MCP客户端)

MCP 客户端（例如 Cursor）需要配置如何启动和连接到这个 MCP 服务器。在客户端的 MCP 设置中添加新的服务器时，通常需要提供服务器名称、启动命令及其参数。

• 服务器名称 (Server Name): 您可以为服务器指定一个易于识别的名称，例如 "Neon MCP"。
• 启动命令 (Command): 这是客户端用于启动 MCP 服务器进程的命令。对于使用 'bun create mcp' 部署的服务器，启动命令通常由安装脚本自动提供并复制到您的剪贴板。它会包含 'bun' 以及必要的参数来启动 Worker。
• 参数 (Args): 这是传递给启动命令的参数列表。同样，这些参数（如 'create', 'mcp', '--clone', 仓库 URL 等）由安装脚本自动生成。

请将安装步骤第一步中复制到剪贴板的内容粘贴到客户端相应的 MCP 服务器配置界面中。客户端将根据这些信息在需要时启动或连接到您的 Cloudflare Worker 上的 MCP 服务器。

请注意，Neon API Key 是服务器端运行时需要的配置，通过 Cloudflare Worker Secrets 进行管理，无需在客户端配置中暴露。

基本使用方法

一旦服务器在客户端中配置并连接成功，您就可以在支持MCP的LLM界面中通过自然语言或特定的指令来调用服务器提供的工具。例如，您可以尝试提问：

• "列出我的所有 Neon 项目。" (对应的 'listProjects' 工具)
• "在项目 'my-project-id' 中列出所有分支。" (对应的 'listBranches' 工具)
• "获取项目 'my-project-id' 中分支 'dev' 的数据库结构。" (对应的 'retrieveDatabaseSchema' 工具)
• "比较项目 'my-project-id' 中分支 'dev' 和 'main' 的数据库结构。" (对应的 'compareSchemas' 工具)

LLM 将识别这些请求并调用相应的 MCP 工具，服务器将执行操作并通过客户端返回结果。