Neon MCP Server 服务说明文档-开发者社区

1. 服务概述

一句话简介：通过自然语言命令管理Neon数据库的MCP服务器

服务名称：Neon MCP Server
版本号：最新版本
开发者/提供方：NeonDatabase Labs
协议类型：MCP (Model Context Protocol)

2. 核心功能

列出该MCP服务提供的主要功能点：

项目管理：创建、删除和描述Neon项目
分支管理：管理数据库分支，包括创建、删除和描述分支
SQL执行：安全运行SQL命令和查询
数据库迁移：在LLM辅助下管理数据库模式迁移
自然语言交互：通过Claude Desktop进行自然语言处理和命令执行
数据查询：列出和描述现有项目及其数据

3. 使用场景

描述该服务适合在什么情况下使用：

典型应用场景

数据库快速部署：通过自然语言快速创建和管理Postgres数据库，无需编写复杂的SQL命令
开发环境管理：为不同开发阶段创建和管理数据库分支，实现开发、测试、生产环境的隔离
数据迁移辅助：利用大语言模型的智能辅助，安全地进行数据库模式迁移和数据结构变更
数据库监控：快速查看和描述现有项目状态、分支信息和数据概况
团队协作：通过自然语言接口，使非技术团队成员也能参与数据库管理操作
自动化工作流：结合Claude Desktop的自动化能力，构建数据库管理的自动化流程

4. 接入方式

4.1 服务端点

Neon MCP Server可以通过以下方式接入：

Smithery安装：通过Smithery包管理器安装
本地运行：在本地环境中直接运行服务器
集成客户端：支持Claude Desktop、Cline等多种MCP客户端

4.2 认证与权限

使用Neon MCP Server需要进行以下认证配置：

Neon API密钥：必须提供有效的Neon API密钥，可通过Neon控制台生成
权限范围：API密钥需要具备项目管理和数据库操作的相应权限
安全建议：妥善保管API密钥，避免在代码中硬编码，建议使用环境变量或密钥管理工具

4.3 数据格式

Neon MCP Server支持以下数据格式：

请求格式：JSON格式的MCP协议请求
响应格式：JSON格式的结构化响应数据
SQL查询：标准SQL语句格式
数据库模式：PostgreSQL兼容的DDL语句

4.4 服务器配置

在MCP客户端配置中添加服务：

{ "mcpServers": { "neon": { "command": "npx", "args": [ "-y", "@neondatabase/mcp-server-neon" ], "env": { "NEON_API_KEY": "your_neon_api_key_here" } } } }

5. 接口定义

Neon MCP Server提供以下主要接口：

接口名称	方法	参数	返回值	说明
create_project	POST	name, region	project_id, connection_string	创建新的Neon项目
delete_project	DELETE	project_id	success, message	删除指定项目
describe_project	GET	project_id	project_details	获取项目详细信息
list_projects	GET	无	projects_list	列出所有项目
create_branch	POST	project_id, branch_name	branch_id, connection_string	创建数据库分支
delete_branch	DELETE	project_id, branch_id	success, message	删除指定分支
execute_sql	POST	project_id, branch_id, sql_query	query_result	执行SQL查询
run_migration	POST	project_id, branch_id, migration_script	migration_result	运行数据库迁移

6. 快速开始

6.1 环境要求

Node.js：建议使用Node.js 18或更高版本
Neon账户：需要注册Neon账户并获取API密钥
MCP客户端：Claude Desktop、Cline或其他支持MCP协议的客户端
网络连接：需要稳定的网络连接访问Neon API

6.2 示例代码

安装Neon MCP Server：

# 通过Smithery安装 smithery install @neondatabase/mcp-server-neon # 或使用npx直接运行 npx -y @neondatabase/mcp-server-neon

配置环境变量：

# Windows PowerShell $env:NEON_API_KEY="your_neon_api_key_here" # Linux/Mac export NEON_API_KEY="your_neon_api_key_here"

Claude Desktop配置示例：

{ "mcpServers": { "neon": { "command": "npx", "args": ["-y", "@neondatabase/mcp-server-neon"], "env": { "NEON_API_KEY": "your_neon_api_key_here" } } } }

使用示例（自然语言命令）：

# 创建新项目 "请创建一个名为'my-app'的Neon项目" # 创建数据库分支 "为项目'proj_123'创建一个名为'develop'的分支" # 执行SQL查询 "在项目'proj_123'的分支'develop'中查询所有用户表" # 运行迁移 "帮我运行数据库迁移脚本，添加新的用户表结构"