使用说明
基本能力
产品定位
Neon MCP Server 是一个基于自然语言的数据库管理工具,旨在简化用户与 Neon Postgres 数据库的交互过程。
核心功能
- 自然语言交互:通过直观的对话命令管理 Neon 数据库。
- 简化的数据库管理:无需编写 SQL 或直接使用 Neon API 即可执行复杂操作。
- 非开发人员友好:使不同技术背景的用户能够轻松与 Neon 数据库交互。
- 数据库迁移支持:利用 Neon 的分支功能通过自然语言启动数据库模式更改。
适用场景
- 通过自然语言创建和管理 Neon 数据库项目。
- 执行数据库查询和事务。
- 进行数据库迁移和性能调优。
- 管理数据库分支和计算资源。
工具列表
- 项目管理:
list_projects,describe_project,create_project,delete_project - 分支管理:
create_branch,delete_branch,describe_branch,list_branch_computes - SQL 查询执行:
get_connection_string,run_sql,run_sql_transaction,get_database_tables,describe_table_schema,list_slow_queries - 数据库迁移:
prepare_database_migration,complete_database_migration - 查询性能调优:
explain_sql_statement,prepare_query_tuning,complete_query_tuning - Neon 认证:
provision_neon_auth
使用教程
使用依赖
- MCP 客户端应用程序。
- Neon 账户。
- Node.js (>= v18.0.0) 和 npm。
安装教程
远程托管 MCP 服务器(预览版)
- 在客户端的 MCP 服务器配置文件中添加以下配置:
{ "mcpServers": { "Neon": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.neon.tech/sse"] } } } - 保存配置文件。
- 重启或刷新 MCP 客户端。
- 按照浏览器中的 OAuth 提示授权客户端访问 Neon 账户。
本地 MCP 服务器
- 通过 Smithery 安装:
npx -y @smithery/cli@latest install neon --client <client_name> - 输入 Neon API 密钥。
- 重启 MCP 客户端。
或手动添加配置到客户端的 mcp_config 文件:
{
"mcpServers": {
"neon": {
"command": "npx",
"args": [
"-y",
"@neondatabase/mcp-server-neon",
"start",
"<YOUR_NEON_API_KEY>"
]
}
}
}
调试方式
- 运行测试:
npm run test - 开发模式:
npm install npm run build npm run watch cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon