mcp-server-neon

Official
MIT License
431
205
  • Linux
  • Apple

Servidor Neon MCP

Neon MCP Server es una herramienta de código abierto que le permite interactuar con sus bases de datos Neon Postgres en lenguaje natural .

El Protocolo de Contexto de Modelo (MCP) es un nuevo protocolo estandarizado diseñado para gestionar el contexto entre grandes modelos de lenguaje (LLM) y sistemas externos. Este repositorio ofrece un instalador y un servidor MCP para Neon .

El servidor MCP de Neon actúa como puente entre las solicitudes en lenguaje natural y la API de Neon . Basado en MCP, traduce sus solicitudes en las llamadas API necesarias, lo que le permite gestionar tareas como la creación de proyectos y ramas, la ejecución de consultas y la migración de bases de datos sin problemas.

Algunas de las características clave del servidor Neon MCP incluyen:

  • Interacción en lenguaje natural: administre las bases de datos de Neon utilizando comandos conversacionales intuitivos.
  • Gestión de bases de datos simplificada: realice acciones complejas sin escribir SQL o utilizar directamente la API de Neon.
  • Accesibilidad para quienes no son desarrolladores: permita a los usuarios con distintos antecedentes técnicos interactuar con las bases de datos de Neon.
  • Soporte para migración de bases de datos: aproveche las capacidades de ramificación de Neon para cambios de esquema de base de datos iniciados a través del lenguaje natural.

Por ejemplo, en Claude Desktop o cualquier cliente MCP, puedes usar lenguaje natural para lograr cosas con Neon, como:

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

[!NOTA]
El servidor Neon MCP ofrece potentes funciones de gestión de bases de datos mediante solicitudes de lenguaje natural. Revise y autorice siempre las acciones solicitadas por el LLM antes de ejecutarlas. Asegúrese de que solo los usuarios y aplicaciones autorizados tengan acceso al servidor Neon MCP y a las claves API de Neon.

Configuración del servidor Neon MCP

Tiene dos opciones para conectar su cliente MCP a Neon:

  1. Servidor MCP remoto (versión preliminar): Conéctese al servidor MCP administrado de Neon mediante OAuth para la autenticación. Este método es más práctico, ya que elimina la necesidad de administrar claves API. Además, recibirá automáticamente las últimas funciones y mejoras en cuanto se publiquen.
  2. Servidor MCP local: ejecute el servidor MCP de Neon localmente en su máquina, autenticándose con una clave API de Neon.

Prerrequisitos

Para configurar el servidor MCP local, también necesita una clave API de Neon. Consulte la documentación de claves API de Neon para obtener instrucciones sobre cómo generarla.

Opción 1. Servidor MCP alojado remotamente (versión preliminar)

Conéctese al servidor MCP administrado de Neon mediante OAuth para la autenticación. Esta es la configuración más sencilla, no requiere la instalación local de este servidor ni la configuración de una clave API de Neon en el cliente.

  • Agregue la siguiente entrada "Neon" al archivo de configuración del servidor MCP de su cliente (por ejemplo, mcp.json , mcp_config.json ):
    { "mcpServers": { "Neon": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.neon.tech/sse"] } } }
  • Guarde el archivo de configuración.
  • Reinicie o actualice su cliente MCP.
  • Se abrirá una ventana de OAuth en su navegador. Siga las instrucciones para autorizar a su cliente MCP a acceder a su cuenta de Neon.

Opción 2. Servidor MCP local

Ejecute el servidor Neon MCP en su máquina local.

Configuración a través de Smithery:

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

Se le solicitará que ingrese su clave de API de Neon. Ingrese la clave de API que obtuvo en la sección de prerrequisitos. Reemplace <client_name> por el nombre de su aplicación cliente de MCP. Los nombres de cliente compatibles incluyen:

Reinicie su cliente MCP después de la instalación.

Configuración a través de npm

Si su cliente MCP no aparece aquí, puede agregar manualmente los detalles del servidor Neon MCP al archivo mcp_config de su cliente.

Agregue la siguiente configuración JSON dentro de la sección mcpServers del archivo mcp_config de su cliente, reemplazando <YOUR_NEON_API_KEY> con su clave API de Neon real:

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

Solución de problemas

Si su cliente no usa JSON para la configuración de servidores MCP (como versiones anteriores de Cursor), puede usar el siguiente comando cuando se le solicite:

npx -y @neondatabase/mcp-server-neon start <YOUR_NEON_API_KEY>
Solución de problemas en Windows

Si usa Windows y tiene problemas al agregar el servidor MCP, es posible que deba usar el Símbolo del sistema ( cmd ) o el Subsistema de Windows para Linux ( wsl ) para ejecutar los comandos necesarios. Su configuración podría ser similar a la siguiente:

{ "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>" ] } } }

Guías

Características

Herramientas compatibles

El servidor Neon MCP proporciona las siguientes acciones, que se exponen como "herramientas" a los clientes MCP. Puede usar estas herramientas para interactuar con sus proyectos y bases de datos Neon mediante comandos de lenguaje natural.

Gestión de proyectos:

  • list_projects : recupera una lista de sus proyectos Neon, proporcionando un resumen de cada proyecto asociado con su cuenta Neon.
  • describe_project : obtiene información detallada sobre un proyecto Neon específico, incluido su ID, nombre y ramas y bases de datos asociadas.
  • create_project : Crea un nuevo proyecto Neon en tu cuenta de Neon. Un proyecto funciona como contenedor de ramas, bases de datos, roles y cómputos.
  • delete_project : elimina un proyecto Neon existente y todos sus recursos asociados.

Gestión de sucursales:

  • create_branch : Crea una nueva rama dentro de un proyecto Neon específico. Aprovecha la función de ramificación de Neon para desarrollo, pruebas o migraciones.
  • delete_branch : elimina una rama existente de un proyecto Neon.
  • describe_branch : recupera detalles sobre una rama específica, como su nombre, ID y rama principal.

Ejecución de consulta SQL:

  • get_connection_string : Devuelve la cadena de conexión a su base de datos.
  • run_sql : Ejecuta una única consulta SQL en una base de datos Neon especificada. Admite operaciones de lectura y escritura.
  • run_sql_transaction : ejecuta una serie de consultas SQL dentro de una sola transacción contra una base de datos Neon.
  • get_database_tables : enumera todas las tablas dentro de una base de datos Neon especificada.
  • describe_table_schema : recupera la definición del esquema de una tabla específica, detallando columnas, tipos de datos y restricciones.

Migraciones de bases de datos (cambios de esquema):

  • prepare_database_migration : Inicia un proceso de migración de base de datos. Fundamentalmente, crea una rama temporal para aplicar y probar la migración de forma segura antes de que afecte a la rama principal.
  • complete_database_migration : Finaliza y aplica una migración de base de datos preparada a la rama principal. Esta acción fusiona los cambios de la rama de migración temporal y limpia los recursos temporales.

Autenticación de neón:

  • provision_neon_auth : Acción para aprovisionar Neon Auth para un proyecto Neon. Permite a los desarrolladores configurar fácilmente la infraestructura de autenticación mediante la creación de una integración con Stack Auth ( @stackframe/stack ).

Migraciones

Las migraciones permiten gestionar los cambios en el esquema de la base de datos a lo largo del tiempo. Con el servidor Neon MCP, los LLM pueden realizar migraciones de forma segura con comandos independientes de "Inicio" ( prepare_database_migration ) y "Confirmar" ( complete_database_migration ).

El comando "Iniciar" acepta una migración y la ejecuta en una nueva rama temporal. Al regresar, este comando indica al LLM que debe probar la migración en esta rama. El LLM puede entonces ejecutar el comando "Confirmar" para aplicar la migración a la rama original.

Desarrollo

Desarrollo con cliente CLI de MCP

La forma más sencilla de iterar en el servidor MCP es mediante mcp-client/ . Obtenga más información en 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

Desarrollo con Claude Desktop (Servidor MCP local)

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

Luego, reinicie Claude cada vez que desee probar los cambios.

Pruebas

Para ejecutar las pruebas es necesario configurar el archivo .env de acuerdo con el archivo .env.example .

npm run test
-
security - not tested
A
license - permissive license
-
quality - not tested

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Le permite utilizar Claude Desktop, o cualquier cliente MCP, para utilizar lenguaje natural para lograr cosas con Neon .

  1. Configuración del servidor Neon MCP
    1. Prerrequisitos
      1. Opción 1. Servidor MCP alojado remotamente (versión preliminar)
      2. Opción 2. Servidor MCP local
      3. Solución de problemas
    2. Guías
      1. Características
        1. Herramientas compatibles
        2. Migraciones
      2. Desarrollo
        1. Desarrollo con cliente CLI de MCP
        2. Desarrollo con Claude Desktop (Servidor MCP local)
      3. Pruebas

        Related MCP Servers

        • -
          security
          A
          license
          -
          quality
          Lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things on your Cloudflare account.
          Last updated -
          928
          1,981
          TypeScript
          Apache 2.0
          • Apple
        • -
          security
          A
          license
          -
          quality
          This lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things with Neo4j and your Aura account.
          Last updated -
          269
          Python
          MIT License
        • -
          security
          A
          license
          -
          quality
          Connects Reaper projects to an MCP client like Claude Desktop, allowing users to ask questions and retrieve parsed information about the projects using natural language.
          Last updated -
          11
          Python
          MIT License
        • -
          security
          F
          license
          -
          quality
          An MCP server that enables AI assistants like Claude to interact with Anki flashcard decks, allowing users to create, manage, and update flashcards through natural language conversations.
          Last updated -
          1
          TypeScript

        View all related MCP servers

        ID: 1yes4hhjq4