霓虹Mcp服务器

什么是 MCP Server Neon？

MCP Server Neon 是一个强大的服务器，旨在与 Neon 管理 API 和数据库进行交互。它为开发者提供了一个强大的平台，以高效管理和操作数据。该服务器旨在促进应用程序与 Neon 数据库之间的无缝通信，确保高性能和可靠性。

MCP Server Neon 的特点

• API 集成：轻松连接和与 Neon 管理 API 进行交互，以简化数据库操作。
• 数据库管理：简化数据库的管理，允许轻松创建、删除和修改数据库条目。
• 公开仓库：MCP Server Neon 是开源的，并在 GitHub 上可用，鼓励全球开发者的合作和贡献。
• 用户友好的界面：以可用性为设计理念，使其对新手和经验丰富的开发者都易于访问。
• 活跃的社区：受益于充满活力的贡献者和用户社区，他们提供支持并分享知识。

如何使用 MCP Server Neon

1. 安装：使用以下命令从 GitHub 克隆仓库：

   git clone https://github.com/neondatabase-labs/mcp-server-neon.git
   

2. 配置：通过在配置文件中配置必要的 API 密钥和数据库连接设置来设置您的环境。
3. 运行服务器：使用以下命令启动服务器：

   npm start
   

4. 与 API 交互：使用 RESTful API 调用执行操作，例如在您的 Neon 数据库中创建、读取、更新和删除数据。
5. 文档：参考官方文档以获取有关如何有效利用服务器的详细说明和示例。

常见问题解答

MCP Server Neon 支持哪些编程语言？

MCP Server Neon 主要使用 JavaScript 和 Node.js 构建，兼容任何支持这些技术的环境。

MCP Server Neon 是免费使用的吗？

是的，MCP Server Neon 是一个开源项目，采用 MIT 许可证，允许您自由使用、修改和分发。

我如何为 MCP Server Neon 项目做贡献？

您可以通过分叉仓库、进行更改并提交拉取请求来贡献。社区欢迎各种形式的贡献，包括错误修复、新功能和文档改进。

我在哪里可以找到有关 MCP Server Neon 的更多信息？

有关更多信息，请访问 MCP Server Neon GitHub 仓库，您可以在此找到源代码、文档和社区讨论。

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://neon.com/brand/neon-logo-dark-color.svg"> <source media="(prefers-color-scheme: light)" srcset="https://neon.com/brand/neon-logo-light-color.svg"> <img width="250px" alt="Neon Logo fallback" src="https://neon.com/brand/neon-logo-dark-color.svg"> </picture>

Neon MCP Server

Neon MCP Server is an open-source tool that lets you interact with your Neon Postgres databases in natural language.

The Model Context Protocol (MCP) is a new, standardized protocol designed to manage context between large language models (LLMs) and external systems. This repository offers an installer and an MCP Server for Neon.

Neon's MCP server acts as a bridge between natural language requests and the Neon API. Built upon MCP, it translates your requests into the necessary API calls, enabling you to manage tasks such as creating projects and branches, running queries, and performing database migrations seamlessly.

Some of the key features of the Neon MCP server include:

• Natural language interaction: Manage Neon databases using intuitive, conversational commands.
• Simplified database management: Perform complex actions without writing SQL or directly using the Neon API.
• Accessibility for non-developers: Empower users with varying technical backgrounds to interact with Neon databases.
• Database migration support: Leverage Neon's branching capabilities for database schema changes initiated via natural language.

For example, in Claude Desktop, or any MCP Client, you can use natural language to accomplish things with Neon, such as:

• Let's create a new Postgres database, and call it "my-database". Let's then create a table called users with the following columns: id, name, email, and password.
• I want to run a migration on my project called "my-project" that alters the users table to add a new column called "created_at".
• Can you give me a summary of all of my Neon projects and what data is in each one?

[!WARNING]
Neon MCP Server Security Considerations
The Neon MCP Server grants powerful database management capabilities through natural language requests. Always review and authorize actions requested by the LLM before execution. Ensure that only authorized users and applications have access to the Neon MCP Server.

The Neon MCP Server is intended for local development and IDE integrations only. We do not recommend using the Neon MCP Server in production environments. It can execute powerful operations that may lead to accidental or unauthorized changes.

For more information, see MCP security guidance →.

Setting up Neon MCP Server

You have two options for connecting your MCP client to Neon:

1. Remote MCP Server (Preview): Connect to Neon's managed MCP server using OAuth for authentication. This method is more convenient as it eliminates the need to manage API keys. Additionally, you will automatically receive the latest features and improvements as soon as they are released.

2. Local MCP Server: Run the Neon MCP server locally on your machine, authenticating with a Neon API key.

Prerequisites

• An MCP Client application.
• A Neon account.
• Node.js (>= v18.0.0) and npm: Download from nodejs.org.

For Local MCP Server setup, you also need a Neon API key. See Neon API Keys documentation for instructions on generating one.

Option 1. Remote Hosted MCP Server (Preview)

Connect to Neon's managed MCP server using OAuth for authentication. This is the easiest setup, requires no local installation of this server, and doesn't need a Neon API key configured in the client.

• Add the following "Neon" entry to your client's MCP server configuration file (e.g., mcp.json, mcp_config.json):

  {
    "mcpServers": {
      "Neon": {
        "command": "npx",
        "args": ["-y", "mcp-remote", "https://mcp.neon.tech/mcp"]
      }
    }
  }
  

• Save the configuration file.

• Restart or refresh your MCP client.

• An OAuth window will open in your browser. Follow the prompts to authorize your MCP client to access your Neon account.

With OAuth base authentication, the MCP server will, by default operate on projects under your personal Neon account. To access or manage projects under organization, you must explicitly provider either the org_id or the project_id in your prompt to MCP client.

Remote MCP Server also supports authentication using API key in the Authorization header if your client supports it

{
  "mcpServers": {
    "Neon": {
      "url": "https://mcp.neon.tech/mcp",
      "headers": {
        "Authorization": "Bearer <$NEON_API_KEY>"
      }
    }
  }
}

Provider organization's API key to limit access to projects under the organization only.

MCP supports two remote server transports: the deprecated Server-Sent Events (SSE) and the newer, recommended Streamable HTTP. If your LLM client doesn't support Streamable HTTP yet, you can switch the endpoint from https://mcp.neon.tech/mcp to https://mcp.neon.tech/sse to use SSE instead.

Option 2. Local MCP Server

Run the Neon MCP server on your local machine with your Neon API key. This method allows you to manage your Neon projects and databases without relying on a remote MCP server.

Add the following JSON configuration within the mcpServers section of your client's mcp_config file, replacing <YOUR_NEON_API_KEY> with your actual Neon API key:

{
  "mcpServers": {
    "neon": {
      "command": "npx",
      "args": [
        "-y",
        "@neondatabase/mcp-server-neon",
        "start",
        "<YOUR_NEON_API_KEY>"
      ]
    }
  }
}

Troubleshooting

If your client does not use JSON for configuration of MCP servers (such as older versions of Cursor), you can use the following command when prompted:

npx -y @neondatabase/mcp-server-neon start <YOUR_NEON_API_KEY>

Troubleshooting on Windows

If you are using Windows and encounter issues while adding the MCP server, you might need to use the Command Prompt (cmd) or Windows Subsystem for Linux (wsl) to run the necessary commands. Your configuration setup may resemble the following:

{
  "mcpServers": {
    "neon": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "@neondatabase/mcp-server-neon",
        "start",
        "<YOUR_NEON_API_KEY>"
      ]
    }
  }
}

{
  "mcpServers": {
    "neon": {
      "command": "wsl",
      "args": [
        "npx",
        "-y",
        "@neondatabase/mcp-server-neon",
        "start",
        "<YOUR_NEON_API_KEY>"
      ]
    }
  }
}

Guides

• Neon MCP Server Guide
• Connect MCP Clients to Neon
• Cursor with Neon MCP Server
• Claude Desktop with Neon MCP Server
• Cline with Neon MCP Server
• Windsurf with Neon MCP Server
• Zed with Neon MCP Server

Features

Supported Tools

The Neon MCP Server provides the following actions, which are exposed as "tools" to MCP Clients. You can use these tools to interact with your Neon projects and databases using natural language commands.

Project Management:

• list_projects: Lists the first 10 Neon projects in your account, providing a summary of each project. If you can't find a specific project, increase the limit by passing a higher value to the limit parameter.
• describe_project: Fetches detailed information about a specific Neon project, including its ID, name, and associated branches and databases.
• create_project: Creates a new Neon project in your Neon account. A project acts as a container for branches, databases, roles, and computes.
• delete_project: Deletes an existing Neon project and all its associated resources.

Branch Management:

• create_branch: Creates a new branch within a specified Neon project. Leverages Neon's branching feature for development, testing, or migrations.
• delete_branch: Deletes an existing branch from a Neon project.
• describe_branch: Retrieves details about a specific branch, such as its name, ID, and parent branch.
• list_branch_computes: Lists compute endpoints for a project or specific branch, including compute ID, type, size, and autoscaling information.
• list_organizations: Lists all organizations that the current user has access to. Optionally filter by organization name or ID using the search parameter.

SQL Query Execution:

• get_connection_string: Returns your database connection string.
• run_sql: Executes a single SQL query against a specified Neon database. Supports both read and write operations.
• run_sql_transaction: Executes a series of SQL queries within a single transaction against a Neon database.
• get_database_tables: Lists all tables within a specified Neon database.
• describe_table_schema: Retrieves the schema definition of a specific table, detailing columns, data types, and constraints.
• list_slow_queries: Identifies performance bottlenecks by finding the slowest queries in a database. Requires the pg_stat_statements extension.

Database Migrations (Schema Changes):

• prepare_database_migration: Initiates a database migration process. Critically, it creates a temporary branch to apply and test the migration safely before affecting the main branch.
• complete_database_migration: Finalizes and applies a prepared database migration to the main branch. This action merges changes from the temporary migration branch and cleans up temporary resources.

Query Performance Optimization:

• explain_sql_statement: Provides detailed execution plans for SQL queries to help identify performance bottlenecks.
• prepare_query_tuning: Analyzes query performance and suggests optimizations like index creation. Creates a temporary branch for safely testing these optimizations.
• complete_query_tuning: Applies or discards query optimizations after testing. Can merge changes from the temporary branch to the main branch.
• list_slow_queries: Identifies and analyzes slow-performing queries in your database. Requires the pg_stat_statements extension.

Compute Management:

• list_branch_computes: Lists compute endpoints for a project or specific branch, showing details like compute ID, type, size, and last active time.

Neon Auth:

• provision_neon_auth: Provisions Neon Auth for a Neon project. It allows developers to easily set up authentication infrastructure by creating an integration with Stack Auth (@stackframe/stack).

  Query Performance Tuning:

• explain_sql_statement: Analyzes a SQL query and returns detailed execution plan information to help understand query performance.

• prepare_query_tuning: Identifies potential performance issues in a SQL query and suggests optimizations. Creates a temporary branch for testing improvements.

• complete_query_tuning: Finalizes and applies query optimizations after testing. Merges changes from the temporary tuning branch to the main branch.

Neon Auth:

• provision_neon_auth: Action to provision Neon Auth for a Neon project. It allows developers to easily setup authentication infrastructure by creating a integration with Stack Auth (@stackframe/stack).

Migrations

Migrations are a way to manage changes to your database schema over time. With the Neon MCP server, LLMs are empowered to do migrations safely with separate "Start" (prepare_database_migration) and "Commit" (complete_database_migration) commands.

The "Start" command accepts a migration and runs it in a new temporary branch. Upon returning, this command hints to the LLM that it should test the migration on this branch. The LLM can then run the "Commit" command to apply the migration to the original branch.

Development

Development with MCP CLI Client

The easiest way to iterate on the MCP Server is using the mcp-client/. Learn more in mcp-client/README.md.

npm install
npm run build
npm run watch # You can keep this open.
cd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon

Development with Claude Desktop (Local MCP Server)

npm install
npm run build
npm run watch # You can keep this open.
node dist/index.js init $NEON_API_KEY

Then, restart Claude each time you want to test changes.

Testing

To run the tests you need to setup the .env file according to the .env.example file.

npm run test