Neon MCP Server 使用说明

项目简介

Neon MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，专为 Neon 数据库设计。它允许大型语言模型 (LLM) 客户端（如 Claude Desktop）通过自然语言指令与 Neon 数据库进行交互，实现数据库管理和数据操作等任务。

主要功能点

Neon 数据库管理: 支持 Neon 项目和分支的创建、删除、描述和列表查看。
SQL 执行: 允许 LLM 客户端执行 SQL 查询和事务，包括单条 SQL 语句和多条 SQL 语句的事务。
数据库结构探索: 提供工具来获取数据库中的表列表，并描述表的结构信息。
安全数据库迁移: 支持通过临时的开发分支进行数据库迁移，提供“准备迁移”和“完成迁移”两阶段操作，确保数据库变更的安全性和可追溯性。
会话式交互: 通过与 Claude Desktop 等 MCP 客户端集成，实现自然语言的数据库操作体验。

安装步骤

安装 Node.js: 确保你的系统已安装 Node.js v18.0.0 或更高版本。
安装 Neon MCP Server: 打开终端，运行以下命令，使用 Smithery 自动安装 Neon MCP Server 到 Claude Desktop：
```
npx -y @smithery/cli install neon --client claude
```
这个命令会自动下载并配置 Neon MCP Server。
获取 Neon API Key: 访问 Neon Console 创建或获取你的 Neon API Key。

服务器配置

MCP 客户端（如 Claude Desktop）需要配置以下 JSON 格式信息以连接到 Neon MCP Server。请注意，以下是 Claude Desktop 'claude_desktop_config.json' 配置文件中 'mcpServers' 字段的配置示例，您无需手动创建或编辑 JSON 代码。 Claude 客户端会自动读取和使用此配置。

{
  "neon": {
    "serverName": "neon",
    "command": "npx",
    "args": [
      "-y",
      "@neondatabase/mcp-server-neon",
      "start",
      "YOUR_NEON_API_KEY"
    ],
    "installViaSmithery": true
  }
}

配置参数说明:

'"serverName": "neon"': MCP 服务器的名称，用于在客户端中标识和选择。
'"command": "npx"': 启动 MCP 服务器的命令，这里使用 'npx' 运行 npm 包。
'"args": [...]' : 启动命令的参数列表。
- '"-y"': 'npx' 参数，表示自动确认安装包。
- '"@neondatabase/mcp-server-neon"': 要运行的 npm 包名称，即 Neon MCP Server。
- '"start"': Neon MCP Server 的启动命令。
- '"YOUR_NEON_API_KEY"': 请替换为你的实际 Neon API Key。 注意：此处的 'YOUR_NEON_API_KEY' 仅为占位符，实际配置时需要替换为真实 API Key。 通过 Smithery 安装时，API Key 通常会在安装过程中配置，无需手动修改配置文件。
'"installViaSmithery": true': 指示此服务器是通过 Smithery 安装的。

重要提示: 请勿手动编辑 'claude_desktop_config.json' 文件，除非你非常清楚自己在做什么。使用 'npx -y @smithery/cli install neon --client claude' 命令会自动完成配置。

基本使用方法

启动 Claude Desktop: 安装配置完成后，重启或启动 Claude Desktop 客户端。
自然语言指令: 在 Claude Desktop 中，你可以使用自然语言指令与 Neon 数据库进行交互。例如：
- 'List me all my Neon projects' (列出所有 Neon 项目)
- 'Create a new Postgres database, and call it "my-database" in project "your-project-id".' (在指定项目中创建一个名为 "my-database" 的数据库)
- 'Run SQL "SELECT * FROM users LIMIT 10" on database "my-database" in project "your-project-id".' (在指定项目和数据库上执行 SQL 查询)
- 'Prepare a database migration to add column 'created_at' to table 'users' in database 'my-database' of project 'your-project-id'. The SQL is: ALTER TABLE users ADD COLUMN created_at TIMESTAMP;' (准备数据库迁移)
- 'Complete database migration with migration ID 'your-migration-id'.' (完成数据库迁移)

请参考仓库 README.md 文件和工具描述获取更详细的使用说明和支持的工具列表。

关键词