返回 MCP 目录
public公开dns本地运行

Neon

Neon MCP Server是一个开源工具,允许用户通过自然语言与Neon Postgres数据库交互,简化数据库管理任务。

article

README

🚀 Neon MCP服务器

Neon MCP服务器是一款功能强大的工具,支持项目管理、数据库管理、迁移管理和安全认证等操作。同时,它也为开发者提供了本地开发和测试的支持,方便开发者进行功能扩展和问题修复。

🚀 快速开始

要快速安装Neon MCP服务器,请按照以下步骤操作:

npm install neon-mcp-server

然后运行以下命令启动服务:

npx neon-mcp-server --init <你的NEON_API_KEY>

更多详细信息请参考官方文档

✨ 主要特性

  • 项目管理:支持对项目的创建、删除和查看操作。
  • 数据库管理:提供对数据库的连接和查询操作。
  • 迁移管理:支持数据库的迁移操作,确保数据安全。
  • 安全认证:支持通过命令配置身份验证。

📦 安装指南

快速安装

npm install neon-mcp-server

启动服务:

npx neon-mcp-server --init <你的NEON_API_KEY>

项目管理

创建项目

npx neon-mcp-server project create --name <项目名称>

删除项目

npx neon-mcp-server project delete --id <项目ID>

查看项目列表

npx neon-mcp-server project list

数据库管理

获取数据库连接字符串

npx neon-mcp-server database connection-string --project-id <项目ID>

执行SQL查询

npx neon-mcp-server database query --project-id <项目ID> --query "SELECT * FROM users;"

迁移管理

创建迁移

npx neon-mcp-server migration create --name <迁移名称>

执行迁移

npx neon-mcp-server migration run --name <迁移名称>

安全认证

npx neon-mcp-server auth provision --project-id <项目ID>

💻 使用示例

基础用法

以下是一个简单的安装和启动Neon MCP服务器的示例:

# 安装服务器
npm install neon-mcp-server
# 启动服务
npx neon-mcp-server --init <你的NEON_API_KEY>

高级用法

以下是一些高级操作的示例,如项目管理、数据库管理等:

# 创建项目
npx neon-mcp-server project create --name my_project
# 获取数据库连接字符串
npx neon-mcp-server database connection-string --project-id my_project_id
# 执行SQL查询
npx neon-mcp-server database query --project-id my_project_id --query "SELECT * FROM users;"

📚 详细文档

更多详细信息请参考官方文档

🔧 技术细节

本地开发

克隆仓库

git clone https://github.com/neonlabs/neon-mcp-server.git
cd neon-mcp-server

安装依赖

npm install

启动开发服务器

npm run dev

测试指南

配置环境变量:

NEON_API_KEY=your_api_key_here
NEON_PROJECT_ID=your_project_id_here

运行测试:

npm test
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端