Neon MCP Server

Neon MCP Server

site icon
2025.04.04 0
TypeScript数据库管理SQL 操作数据库迁移数据库
Neon MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于管理大型语言模型 (LLMs) 与外部系统之间的上下文。它专门为 Neon(一个 Postgres 数据库服务)设计,允许用户通过自然语言指令与 Neon 进行交互,例如创建数据库、运行 SQL 查询、管理数据库迁移等。
View on GitHub

Overview

基本能力

产品定位

Neon MCP Server 是一个专为 Neon 数据库设计的 MCP 服务,旨在通过自然语言指令简化数据库操作和管理。

核心功能

  • 数据库管理:创建、删除和描述 Neon 项目与分支。
  • SQL 操作:运行 SQL 查询和事务,获取数据库表和表结构信息。
  • 数据库迁移:支持安全的数据库迁移管理,包括临时分支测试和正式提交。
  • 连接管理:生成数据库连接字符串,提供 Neon 认证支持。

适用场景

  • 通过自然语言指令创建和管理 Neon 数据库。
  • 运行复杂的 SQL 查询和事务。
  • 安全地进行数据库迁移和架构变更。
  • 快速获取数据库项目和表的结构信息。

工具列表

  • 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:描述表的结构。
  • prepare_database_migration:准备数据库迁移。
  • complete_database_migration:完成数据库迁移。
  • provision_neon_auth:提供 Neon 认证支持。

常见问题解答

  • 如何安装 Neon MCP Server? 通过 Smithery 自动安装或手动安装。
  • 需要哪些前置依赖? Node.js >= v18.0.0、Claude Desktop 和 Neon API 密钥。
  • 如何调试? 使用 MCP CLI 客户端或 Claude Desktop 进行本地开发和测试。

使用教程

使用依赖

  • Node.js >= v18.0.0
  • Claude Desktop
  • Neon API 密钥(可通过 Neon 控制台生成)

安装教程

  1. 通过 Smithery 自动安装: bash npx -y @smithery/cli install neon --client claude
  2. 手动安装: bash npx @neondatabase/mcp-server-neon init $NEON_API_KEY 然后重启 Claude Desktop。

调试方式

  1. 使用 MCP CLI 客户端: bash npm install npm run build npm run watch cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon
  2. 使用 Claude Desktop: bash npm install npm run build npm run watch node dist/index.js init $NEON_API_KEY 每次测试更改时重启 Claude Desktop。

  3. 运行测试: bash npm run test

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。