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 許可證。