Servidor Neon Mcp

¿Qué es MCP Server Neon?

MCP Server Neon es un servidor potente diseñado para interactuar con la API de Gestión de Neon y gestionar bases de datos. Proporciona a los desarrolladores una forma fluida de conectar, gestionar y manipular datos almacenados en bases de datos Neon. Este servidor es particularmente útil para aplicaciones que requieren capacidades robustas de gestión de bases de datos, permitiendo un manejo y recuperación de datos eficientes.

Características de MCP Server Neon

• Integración de API: MCP Server Neon ofrece una fácil integración con la API de Gestión de Neon, lo que permite a los desarrolladores realizar diversas operaciones de base de datos sin esfuerzo.
• Gestión de Bases de Datos: Proporciona herramientas para gestionar bases de datos, incluyendo la creación, actualización y eliminación de registros.
• Interfaz Amigable: El servidor viene con una interfaz amigable que simplifica las interacciones con la base de datos, haciéndola accesible tanto para desarrolladores novatos como experimentados.
• Código Abierto: Al ser un proyecto de código abierto, MCP Server Neon permite a los desarrolladores contribuir a su desarrollo y personalizarlo según sus necesidades.
• Soporte Activo de la Comunidad: El proyecto cuenta con el apoyo de una comunidad activa, asegurando que los usuarios puedan encontrar ayuda y recursos fácilmente.

Cómo Usar MCP Server Neon

1. Instalación: Comienza clonando el repositorio de MCP Server Neon desde GitHub. Puedes hacerlo usando el comando:

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

2. Configuración: Después de clonar, configura los ajustes del servidor de acuerdo a tus requisitos de base de datos. Esto puede implicar configurar variables de entorno o archivos de configuración.
3. Ejecutar el Servidor: Inicia el servidor usando el comando:

   npm start
   

   Asegúrate de que todas las dependencias estén instaladas y que el servidor esté correctamente configurado.
4. Interactuar con la API: Utiliza los endpoints de API proporcionados para interactuar con tus bases de datos Neon. Puedes realizar operaciones CRUD y gestionar tus datos de manera efectiva.
5. Contribuciones de la Comunidad: Si deseas contribuir al proyecto, sigue las pautas de contribución proporcionadas en el repositorio.

Preguntas Frecuentes

P1: ¿Es MCP Server Neon gratuito para usar?

R1: Sí, MCP Server Neon es un proyecto de código abierto y es gratuito para usar.

P2: ¿Puedo contribuir al proyecto MCP Server Neon?

R2: ¡Absolutamente! Las contribuciones son bienvenidas. Puedes enviar problemas, solicitudes de características o solicitudes de extracción en el repositorio de GitHub.

P3: ¿Qué lenguajes de programación se utilizan en MCP Server Neon?

R3: El servidor está construido principalmente con JavaScript y Node.js, lo que lo hace accesible para desarrolladores web.

P4: ¿Cómo puedo reportar problemas o errores?

R4: Puedes reportar problemas abriendo un problema en el repositorio de GitHub. Asegúrate de proporcionar información detallada sobre el problema.

P5: ¿Dónde puedo encontrar la documentación para MCP Server Neon?

R5: La documentación suele estar disponible en el archivo README del repositorio o en una carpeta de docs dedicada. Consulta el repositorio para más detalles.

<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

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?

[!NOTE]
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 and Neon API keys.

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/sse"]
      }
    }
  }
  

• 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.

Option 2. Local MCP Server

Run the Neon MCP server on your local machine.

Setup via Smithery:

npx -y @smithery/cli@latest install neon --client <client_name>

You will be prompted to enter your Neon API key. Enter the API key which you obtained from the prerequisites section Replace <client_name> with the name of your MCP client application. Supported client names include:

• claude for Claude Desktop
• cursor for Cursor (Installing via smithery makes the MCP server a global MCP server in Cursor)
• windsurf for Windsurf Editor
• roo-cline for Roo Cline VS Code extension
• witsy for Witsy
• enconvo for Enconvo
• vscode for Visual Studio Code

Restart your MCP client after installation.

Setup via npm

If your MCP client is not listed here, you can manually add the Neon MCP Server details to your client's mcp_config file.

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.

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