Neondatabase_mcp Server Neon

🚀 Neon MCP 服务器

Neon MCP 服务器基于模型上下文协议（MCP），这是一个用于在大型语言模型（LLMs）和外部系统之间管理上下文的标准化协议。本项目提供了适用于 Neon 的 MCP 服务器及安装程序，让您能通过自然语言命令，如使用 Claude Desktop 或其他 MCP 客户端与 Neon 进行交互。

项目状态

自然语言交互示例

• 让我们创建一个新的 Postgres 数据库，并将其命名为 "my-database"。然后在其中创建一个名为 users 的表，包含以下列：id、name、email 和 password。
• 我想在我的项目 "my-project" 上运行迁移，以在 users 表中添加新的列 "created_at"。
• 你能给我一份所有 Neon 项目的摘要以及每个项目中的数据吗？

🚀 快速开始

通过 Smithery 安装

要通过 Smithery 自动安装 Neon MCP 服务器以用于 Claude Desktop，可运行以下命令：

npx -y @smithery/cli install neon --client claude

前提条件

• Node.js >= v18.0.0
• Claude Desktop
• Neon API 密钥 - 您可以通过 Neon 控制台生成。了解更多信息 或 点击此处 快速访问。

本地使用方法

1. 运行 npx @neondatabase/mcp-server-neon init $NEON_API_KEY
2. 重启 Claude Desktop
3. 您现在应该可以尝试一个简单的命令，例如 列出我所有的 Neon 项目

✨ 主要特性

支持的工具

• list_projects
• describe_project
• create_project
• delete_project
• create_branch
• delete_branch
• describe_branch
• run_sql
• run_sql_transaction
• get_database_tables
• describe_table_schema
• prepare_database_migration
• complete_database_migration

迁移

迁移是一种管理数据库模式随时间变化的方法。借助 Neon MCP 服务器，LLMs 可以通过独立的 "开始" 和 "提交" 命令安全地执行迁徙。

"开始" 命令接受一个迁移并在新的临时分支上运行它。返回后，此命令提示 LLM 在该分支上测试迁移。然后，LLM 可以使用 "提交" 命令将迁移应用到原始分支。

📚 详细文档

开发

迭代 MCP 服务器的最简单方法是使用 mcp-client/。了解更多信息请查看 mcp-client/README.md。

npm install
npm run watch # 您可以保持此窗口打开。
cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon

📄 许可证

本项目采用 MIT 许可证。