mcp-server-neon

mcp-server-neon

允许您使用 Claude Desktop 或任何 MCP 客户端,通过自然语言来完成与 Neon 相关的任务。

编程文档访问
访问服务器

README

Neon MCP 服务器

npm 版本 npm 下载量 License: MIT smithery badge

模型上下文协议 (MCP) 是一种新的标准化协议,用于管理大型语言模型 (LLM) 和外部系统之间的上下文。 在此存储库中,我们提供了一个安装程序以及一个用于 Neon 的 MCP 服务器。

这使您可以使用 Claude Desktop 或任何 MCP 客户端,通过自然语言来完成 Neon 的相关操作,例如:

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

Claude 设置

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 Neon MCP 服务器:

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

  • get_connection_string

  • run_sql

  • run_sql_transaction

  • get_database_tables

  • describe_table_schema

  • prepare_database_migration

  • complete_database_migration

  • provision_neon_auth

迁移

迁移是一种管理数据库模式随时间变化的方式。 使用 Neon MCP 服务器,LLM 可以通过单独的“开始”和“提交”命令安全地进行迁移。

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

开发

使用 MCP CLI 客户端进行开发

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

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

使用 Claude Desktop 进行开发

npm install
npm run build
npm run watch # 您可以保持此打开状态。
node dist/index.js init $NEON_API_KEY

然后,每次要测试更改时,重启 Claude

测试

要运行测试,您需要根据 .env.example 文件设置 .env 文件。

npm run test

推荐服务器