Neon MCP Server
2025.01.09
0
TypeScript数据库管理自然语言交互数据库
Neon MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，用于管理大型语言模型 (LLMs) 与外部系统（如 Neon 数据库服务）之间的上下文交互。它允许用户通过自然语言指令来操作和管理 Neon 数据库，例如创建数据库、运行 SQL 查询、管理数据库迁移等。
View on GitHub
Overview
基本能力
产品定位
Neon MCP Server 是一个数据库管理工具，通过自然语言处理技术简化数据库操作流程，提升开发效率。
核心功能
- 数据库管理：创建、删除、描述项目和分支。
- SQL 操作：运行 SQL 查询和事务，获取数据库表信息。
- 数据库迁移：安全地准备和完成数据库迁移。
- 自然语言交互：通过自然语言指令完成复杂的数据库操作。
适用场景
- 开发人员希望通过自然语言快速管理数据库。
- 团队需要自动化数据库迁移和变更管理。
- 项目需要集成 LLMs 进行数据库操作。
工具列表
list_projects：列出所有 Neon 项目。describe_project：描述特定项目的详细信息。create_project：创建新项目。delete_project：删除项目。create_branch：创建新分支。delete_branch：删除分支。describe_branch：描述分支的详细信息。run_sql：运行 SQL 查询。run_sql_transaction：运行 SQL 事务。get_database_tables：获取数据库表信息。describe_table_schema：描述表的结构。prepare_database_migration：准备数据库迁移。complete_database_migration：完成数据库迁移。
常见问题解答
- 如何获取 Neon API Key：可以通过 Neon 控制台生成，了解更多。
- 如何调试：使用
mcp-client/目录下的工具进行开发和调试。
使用教程
使用依赖
- Node.js >= v18.0.0
- Claude Desktop
- Neon API key
安装教程
- 通过 Smithery 自动安装：
npx -y @smithery/cli install neon --client claude
- 本地使用：
npx @neondatabase/mcp-server-neon init $NEON_API_KEY
- 重启 Claude Desktop。
调试方式
- 安装依赖：
npm install
- 启动监视模式：
npm run watch
- 启动客户端：
cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon