使用说明
项目简介
Neon MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它被部署在 Cloudflare Workers 上,作为一个轻量级的 MCP 服务器运行。该服务器的主要目的是为了让 LLM 客户端(如 Cursor 编辑器)能够通过预设的工具集,与 Neon 数据库的 REST API 进行交互。借助此服务器,用户可以通过 LLM 客户端直接管理 Neon 数据库的资源,例如查看项目列表、管理数据库分支、检索数据库结构信息等。
主要功能点
- 项目管理: 列出 Neon 平台上的所有项目。
- 分支管理: 查看指定项目下的所有数据库分支,获取分支详情,删除分支,以及恢复分支到指定状态。
- 数据库管理: 列出指定分支下的所有数据库。
- Schema管理: 检索指定数据库的 Schema 信息,并支持比较不同分支数据库的 Schema 差异。
安装步骤
-
克隆并部署 MCP 服务器: 运行以下命令,自动化安装 Neon MCP Server 并将其部署到您的 Cloudflare 账户。请确保您已安装 bun 和 wrangler:
bun create mcp --clone https://github.com/zueai/neon-mcp按照提示完成 Cloudflare 账户的授权和 Worker 的部署。
-
配置 MCP 服务器: 在 Cursor 编辑器中,打开 'Settings -> MCP -> Add new MCP server',粘贴在第一步完成后复制到剪贴板的命令。这将添加并配置 Neon MCP Server 到 Cursor。
-
设置 Neon API Key: 您需要将您的 Neon API 密钥上传到 Cloudflare Worker 的 Secrets 中,以便服务器能够安全地访问 Neon API。运行以下命令,并替换为您自己的 Neon API 密钥:
bunx wrangler secret put NEON_API_KEY
服务器配置 (MCP 客户端配置)
对于 MCP 客户端(例如 Cursor),您需要配置以下服务器信息以连接到 Neon MCP Server。通常在客户端的 MCP 服务器配置界面中填写,例如 Cursor 编辑器的 'Settings -> MCP -> Add new MCP server':
{ "serverName": "Neon MCP Server", "command": "<您的 Cloudflare Worker URL>", "args": [] }
- 'serverName': MCP 服务器的名称,可以自定义,例如 "Neon MCP Server"。
- 'command': 这是关键配置,请替换为您的 Neon MCP Server 部署到 Cloudflare Workers 后获得的 Worker URL。这个 URL 是 MCP 客户端连接到服务器的地址。部署成功后,Cloudflare 会提供该 URL。
- 'args': 参数列表,当前配置为空数组 '[]',表示无需额外启动参数。
注意: '<您的 Cloudflare Worker URL>' 需要替换为您实际部署后 Cloudflare 分配的 Worker URL。
基本使用方法
成功配置 Neon MCP Server 后,在 Cursor 编辑器或其他兼容 MCP 协议的 LLM 客户端中,您应该能够使用预设的工具来管理 Neon 数据库资源。具体操作方式取决于客户端的界面和工具集成方式,通常可以通过自然语言指令或图形界面来调用服务器提供的各项功能,例如:
- 在 Cursor 中,您可以尝试使用命令或通过编辑器提供的界面来列出 Neon 项目、查看数据库分支信息、获取数据库 Schema 等。
- 具体工具的使用方法和参数,请参考 Cursor 或其他 LLM 客户端的 MCP 功能文档,以及 Neon MCP Server 代码中 'src/index.ts' 文件内每个函数的详细注释。
信息
分类
数据库与文件