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_projectPOSTname, regionproject_id, connection_string创建新的Neon项目delete_projectDELETEproject_idsuccess, message删除指定项目describe_projectGETproject_idproject_details获取项目详细信息list_projectsGET无projects_list列出所有项目create_branchPOSTproject_id, branch_namebranch_id, connection_string创建数据库分支delete_branchDELETEproject_id, branch_idsuccess, message删除指定分支execute_sqlPOSTproject_id, branch_id, sql_queryquery_result执行SQL查询run_migrationPOSTproject_id, branch_id, migration_scriptmigration_result运行数据库迁移6. 快速开始6.1 环境要求Node.js建议使用Node.js 18或更高版本Neon账户需要注册Neon账户并获取API密钥MCP客户端Claude Desktop、Cline或其他支持MCP协议的客户端网络连接需要稳定的网络连接访问Neon API6.2 示例代码安装Neon MCP Server# 通过Smithery安装 smithery install neondatabase/mcp-server-neon # 或使用npx直接运行 npx -y neondatabase/mcp-server-neon配置环境变量# Windows PowerShell $env:NEON_API_KEYyour_neon_api_key_here # Linux/Mac export NEON_API_KEYyour_neon_api_key_hereClaude 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中查询所有用户表 # 运行迁移 帮我运行数据库迁移脚本添加新的用户表结构7. 注意事项使用注意事项API密钥安全切勿将Neon API密钥提交到版本控制系统建议使用环境变量或密钥管理工具权限控制确保API密钥具有适当的权限范围避免过度授权数据备份在执行删除操作或重大迁移前务必备份重要数据SQL安全谨慎执行SQL命令特别是在生产环境中建议先在测试环境验证网络稳定性确保网络连接稳定避免因网络问题导致操作中断版本兼容关注Neon MCP Server的版本更新及时升级以获取新功能和修复资源限制注意Neon账户的资源限制避免超出配额导致服务中断错误处理妥善处理API返回的错误信息根据错误类型采取相应措施客户端兼容确保使用的MCP客户端版本与Neon MCP Server兼容日志记录建议记录重要操作日志便于问题追踪和审计