基本能力
产品定位
Neon MCP Server 是一个专为 Neon 数据库设计的 MCP 服务,旨在通过自然语言指令简化数据库操作和管理。
核心功能
- 项目管理:创建、删除、列出和描述 Neon 项目。
- 分支管理:创建、删除和描述数据库分支。
- SQL 操作:执行 SQL 查询和事务,获取数据库表和表结构信息。
- 数据库迁移:支持安全的数据库迁移操作,包括准备和提交迁移。
- 认证管理:提供 Neon 认证配置功能。
适用场景
- 开发者希望通过自然语言快速操作和管理 Neon 数据库。
- 数据工程师需要简化数据库迁移和 schema 变更流程。
- 团队协作中,通过自然语言指令共享数据库操作。
工具列表
list_projects
:列出所有 Neon 项目。describe_project
:描述特定项目的详细信息。create_project
:创建新的 Neon 项目。delete_project
:删除指定的 Neon 项目。create_branch
:创建数据库分支。delete_branch
:删除数据库分支。describe_branch
:描述分支的详细信息。get_connection_string
:获取数据库连接字符串。run_sql
:执行 SQL 查询。run_sql_transaction
:执行 SQL 事务。get_database_tables
:获取数据库中的所有表。describe_table_schema
:描述表的 schema 信息。prepare_database_migration
:准备数据库迁移。complete_database_migration
:完成数据库迁移。provision_neon_auth
:配置 Neon 认证。
常见问题解答
- 如何安装 Neon MCP Server? 可以通过 Smithery 自动安装或手动安装。
- 需要哪些前置依赖? Node.js >= v18.0.0 和 Claude Desktop。
- 如何获取 Neon API key? 可以通过 Neon 控制台生成。
使用教程
使用依赖
- Node.js >= v18.0.0
- Claude Desktop
- Neon API key
安装教程
- 通过 Smithery 自动安装:
bash
npx -y @smithery/cli install neon --client claude - 手动安装:
bash
npx @neondatabase/mcp-server-neon init $NEON_API_KEY
然后重启 Claude Desktop。
调试方式
- 使用 MCP CLI 客户端进行开发:
bash
npm install
npm run build
npm run watch
cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon - 使用 Claude Desktop 进行开发:
bash
npm install
npm run build
npm run watch
node dist/index.js init $NEON_API_KEY
每次测试更改时重启 Claude。
测试
bash
npm run test