[{"_1":2,"_334":-5,"_335":-5},"loaderData",{"_3":4,"_22":23,"_259":260},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"bot","id",19346472,"membership","referenceId","0199f420-7955-7299-8090-ea86aef37824","userAccount","routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_24":25,"_78":-5,"_79":38,"_27":80,"_175":176,"_258":152},"availableLocales",[26,38,44,51,57,64,71],{"_27":28,"_31":35,"_36":37},"mcpServer",{"_29":30,"_31":32,"_33":34},"description","Ermöglicht Ihnen die Verwendung von Claude Desktop oder einem beliebigen MCP-Client, um mithilfe natürlicher Sprache Dinge mit [Neon](https://neon.tech/) zu erledigen.","name","mcp-server-neon","readme","# Neon MCP Server\n\n**Neon MCP Server** ist ein Open-Source-Tool, mit dem Sie in **natürlicher Sprache** mit Ihren Neon-Postgres-Datenbanken interagieren können.\n\n[![npm-Version](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![npm-Downloads](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![Lizenz: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Schmiedeabzeichen](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\nDas Model Context Protocol (MCP) ist ein [neues, standardisiertes Protokoll](https://modelcontextprotocol.io/introduction) zur Verwaltung des Kontexts zwischen großen Sprachmodellen (LLMs) und externen Systemen. Dieses Repository bietet ein Installationsprogramm und einen MCP-Server für [Neon](https://neon.tech) .\n\nDer MCP-Server von Neon fungiert als Brücke zwischen natürlichsprachlichen Anfragen und der [Neon-API](https://api-docs.neon.tech/reference/getting-started-with-neon-api) . Basierend auf MCP übersetzt er Ihre Anfragen in die notwendigen API-Aufrufe und ermöglicht Ihnen so die nahtlose Verwaltung von Aufgaben wie dem Erstellen von Projekten und Zweigen, dem Ausführen von Abfragen und der Durchführung von Datenbankmigrationen.\n\nZu den wichtigsten Funktionen des Neon MCP-Servers gehören:\n\n* **Interaktion in natürlicher Sprache:** Verwalten Sie Neon-Datenbanken mit intuitiven, umgangssprachlichen Befehlen.\n* **Vereinfachte Datenbankverwaltung:** Führen Sie komplexe Aktionen aus, ohne SQL zu schreiben oder die Neon-API direkt zu verwenden.\n* **Zugänglichkeit für Nicht-Entwickler:** Ermöglichen Sie Benutzern mit unterschiedlichem technischen Hintergrund die Interaktion mit Neon-Datenbanken.\n* **Unterstützung bei der Datenbankmigration:** Nutzen Sie die Verzweigungsfunktionen von Neon für Datenbankschemaänderungen, die über natürliche Sprache initiiert werden.\n\nBeispielsweise können Sie in Claude Desktop oder einem beliebigen MCP-Client mithilfe natürlicher Sprache Dinge mit Neon erreichen, wie etwa:\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[!NOTIZ]\\\n> Der Neon MCP-Server bietet leistungsstarke Datenbankverwaltungsfunktionen über natürliche Sprachanfragen. **Überprüfen und autorisieren Sie die vom LLM angeforderten Aktionen stets** vor der Ausführung. Stellen Sie sicher, dass nur autorisierte Benutzer und Anwendungen Zugriff auf den Neon MCP-Server und die Neon-API-Schlüssel haben.\n\n## Einrichten des Neon MCP-Servers\n\nSie haben zwei Möglichkeiten, Ihren MCP-Client mit Neon zu verbinden:\n\n1. **Remote-MCP-Server (Vorschau):** Verbinden Sie sich mit dem verwalteten MCP-Server von Neon und verwenden Sie OAuth zur Authentifizierung. Diese Methode ist komfortabler, da Sie keine API-Schlüssel verwalten müssen. Darüber hinaus erhalten Sie automatisch die neuesten Funktionen und Verbesserungen, sobald diese veröffentlicht werden.\n\n2. **Lokaler MCP-Server:** Führen Sie den Neon-MCP-Server lokal auf Ihrem Computer aus und authentifizieren Sie sich mit einem Neon-API-Schlüssel.\n\n## Voraussetzungen\n\n* Eine MCP-Clientanwendung.\n* Ein [Neon-Konto](https://console.neon.tech/signup) .\n* **Node.js (>= v18.0.0) und npm:** Download von [nodejs.org](https://nodejs.org) .\n\nFür die Einrichtung des lokalen MCP-Servers benötigen Sie außerdem einen Neon-API-Schlüssel. Anweisungen zur Generierung finden Sie [in der Dokumentation zu Neon-API-Schlüsseln](https://neon.tech/docs/manage/api-keys) .\n\n### Option 1. Remote gehosteter MCP-Server (Vorschau)\n\nVerbinden Sie sich mit dem verwalteten MCP-Server von Neon und verwenden Sie OAuth zur Authentifizierung. Dies ist die einfachste Einrichtung, erfordert keine lokale Installation des Servers und benötigt keinen im Client konfigurierten Neon-API-Schlüssel.\n\n* Fügen Sie der MCP-Serverkonfigurationsdatei Ihres Clients (z. B. `mcp.json` , `mcp_config.json` ) den folgenden „Neon“-Eintrag hinzu:\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n* Speichern Sie die Konfigurationsdatei.\n\n* Starten Sie Ihren MCP-Client neu oder aktualisieren Sie ihn.\n\n* In Ihrem Browser öffnet sich ein OAuth-Fenster. Folgen Sie den Anweisungen, um Ihrem MCP-Client den Zugriff auf Ihr Neon-Konto zu gestatten.\n\n### Option 2. Lokaler MCP-Server\n\nFühren Sie den Neon MCP-Server auf Ihrem lokalen Computer aus.\n\n**Einrichtung über Smithery:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nSie werden aufgefordert, Ihren Neon-API-Schlüssel einzugeben. Geben Sie den API-Schlüssel ein, den Sie im Abschnitt [„Voraussetzungen“](#prerequisites) erhalten haben. Ersetzen Sie `` durch den Namen Ihrer MCP-Client-Anwendung. Unterstützte Client-Namen sind:\n\n* `claude` für [Claude Desktop](https://claude.ai/download)\n* `cursor` für [Cursor](https://cursor.com) (Die Installation über `smithery` macht den MCP-Server zu einem globalen MCP-Server in Cursor)\n* `windsurf` für [Windsurf Editor](https://codeium.com/windsurf)\n* `roo-cline` für [Roo Cline VS Code-Erweiterung](https://github.com/RooVetGit/Roo-Code)\n* `witsy` für [Witsy](https://witsyai.com/)\n* `enconvo` für [Enconvo](https://www.enconvo.com/)\n* `vscode` für [Visual Studio Code (Vorschau)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\n\nStarten Sie Ihren MCP-Client nach der Installation neu.\n\n**Einrichtung über npm**\n\nWenn Ihr MCP-Client hier nicht aufgeführt ist, können Sie die Neon MCP-Serverdetails manuell zur `mcp_config` Datei Ihres Clients hinzufügen.\n\nFügen Sie die folgende JSON-Konfiguration im Abschnitt `mcpServers` der `mcp_config` Datei Ihres Clients hinzu und ersetzen Sie `` durch Ihren tatsächlichen Neon-API-Schlüssel:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Fehlerbehebung\n\nWenn Ihr Client kein `JSON` zur Konfiguration von MCP-Servern verwendet (z. B. ältere Versionen von Cursor), können Sie bei entsprechender Aufforderung den folgenden Befehl verwenden:\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Fehlerbehebung unter Windows\n\nWenn Sie Windows verwenden und beim Hinzufügen des MCP-Servers Probleme auftreten, müssen Sie möglicherweise die Eingabeaufforderung ( `cmd` ) oder das Windows-Subsystem für Linux ( `wsl` ) verwenden, um die erforderlichen Befehle auszuführen. Ihre Konfiguration könnte wie folgt aussehen:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## Anleitungen\n\n* [Neon MCP-Serverhandbuch](https://neon.tech/docs/ai/neon-mcp-server)\n* [Verbinden Sie MCP-Clients mit Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [Cursor mit Neon MCP Server](https://neon.tech/guides/cursor-mcp-neon)\n* [Claude Desktop mit Neon MCP Server](https://neon.tech/guides/neon-mcp-server)\n* [Cline mit Neon MCP Server](https://neon.tech/guides/cline-mcp-neon)\n* [Windsurfen mit Neon MCP Server](https://neon.tech/guides/windsurf-mcp-neon)\n* [Zed mit Neon MCP Server](https://neon.tech/guides/zed-mcp-neon)\n\n# Merkmale\n\n## Unterstützte Tools\n\nDer Neon MCP-Server bietet die folgenden Aktionen, die MCP-Clients als „Tools“ zur Verfügung gestellt werden. Sie können diese Tools verwenden, um mit Ihren Neon-Projekten und -Datenbanken über natürliche Sprachbefehle zu interagieren.\n\n**Projektmanagement:**\n\n* **`list_projects`** : Ruft eine Liste Ihrer Neon-Projekte ab und bietet eine Zusammenfassung aller mit Ihrem Neon-Konto verknüpften Projekte. Unterstützt die Begrenzung der Anzahl der zurückgegebenen Projekte (Standard: 10).\n* **`describe_project`** : Ruft detaillierte Informationen zu einem bestimmten Neon-Projekt ab, einschließlich seiner ID, seines Namens und der zugehörigen Zweige und Datenbanken.\n* **`create_project`** : Erstellt ein neues Neon-Projekt in Ihrem Neon-Konto. Ein Projekt dient als Container für Zweige, Datenbanken, Rollen und Berechnungen.\n* **`delete_project`** : Löscht ein vorhandenes Neon-Projekt und alle zugehörigen Ressourcen.\n\n**Filialleitung:**\n\n* **`create_branch`** : Erstellt einen neuen Zweig innerhalb eines angegebenen Neon-Projekts. Nutzt [die Branching-Funktion von Neon](/docs/introduction/branching) für Entwicklung, Tests oder Migrationen.\n* **`delete_branch`** : Löscht einen vorhandenen Zweig aus einem Neon-Projekt.\n* **`describe_branch`** : Ruft Details zu einem bestimmten Zweig ab, z. B. Name, ID und übergeordneter Zweig.\n* **`list_branch_computes`** : Listet Compute-Endpunkte für ein Projekt oder einen bestimmten Zweig auf, einschließlich Compute-ID, Typ, Größe und Informationen zur automatischen Skalierung.\n\n**Ausführung der SQL-Abfrage:**\n\n* **`get_connection_string`** : Gibt Ihre Datenbankverbindungszeichenfolge zurück.\n* **`run_sql`** : Führt eine einzelne SQL-Abfrage für eine angegebene Neon-Datenbank aus. Unterstützt sowohl Lese- als auch Schreibvorgänge.\n* **`run_sql_transaction`** : Führt eine Reihe von SQL-Abfragen innerhalb einer einzigen Transaktion für eine Neon-Datenbank aus.\n* **`get_database_tables`** : Listet alle Tabellen innerhalb einer angegebenen Neon-Datenbank auf.\n* **`describe_table_schema`** : Ruft die Schemadefinition einer bestimmten Tabelle ab und gibt Einzelheiten zu Spalten, Datentypen und Einschränkungen an.\n* **`list_slow_queries`** : Identifiziert Leistungsengpässe, indem die langsamsten Abfragen in einer Datenbank ermittelt werden. Erfordert die Erweiterung pg\\_stat\\_statements.\n\n**Datenbankmigrationen (Schemaänderungen):**\n\n* **`prepare_database_migration`** : Startet einen Datenbankmigrationsprozess. Wichtig ist, dass ein temporärer Zweig erstellt wird, um die Migration sicher anzuwenden und zu testen, bevor der Hauptzweig beeinflusst wird.\n* **`complete_database_migration`** : Schließt eine vorbereitete Datenbankmigration ab und wendet sie auf den Hauptzweig an. Diese Aktion führt Änderungen aus dem temporären Migrationszweig zusammen und bereinigt temporäre Ressourcen.\n\n**Optimierung der Abfrageleistung:**\n\n* **`explain_sql_statement`** : Analysiert eine SQL-Abfrage und gibt detaillierte Informationen zum Ausführungsplan zurück, um die Abfrageleistung besser zu verstehen.\n* **`prepare_query_tuning`** : Identifiziert potenzielle Leistungsprobleme in einer SQL-Abfrage und schlägt Optimierungen vor. Erstellt einen temporären Zweig zum Testen von Verbesserungen.\n* **`complete_query_tuning`** : Finalisiert und wendet Abfrageoptimierungen nach dem Test an. Führt Änderungen vom temporären Tuning-Zweig in den Hauptzweig ein.\n\n**Neon-Auth:**\n\n* **`provision_neon_auth`** : Aktion zur Bereitstellung von Neon Auth für ein Neon-Projekt. Entwickler können damit einfach eine Authentifizierungsinfrastruktur einrichten, indem sie eine Integration mit Stack Auth ( `@stackframe/stack` ) erstellen.\n\n## Migrationen\n\nMigrationen sind eine Möglichkeit, Änderungen an Ihrem Datenbankschema im Laufe der Zeit zu verwalten. Mit dem Neon MCP-Server können LLMs Migrationen sicher mit separaten Start- ( `prepare_database_migration` ) und Commit-Befehlen ( `complete_database_migration` ) durchführen.\n\nDer Befehl „Start“ akzeptiert eine Migration und führt sie in einem neuen temporären Zweig aus. Nach der Rückkehr weist dieser Befehl den LLM darauf hin, die Migration in diesem Zweig zu testen. Anschließend kann der LLM den Befehl „Commit“ ausführen, um die Migration auf den ursprünglichen Zweig anzuwenden.\n\n# Entwicklung\n\n## Entwicklung mit MCP CLI-Client\n\nDie einfachste Möglichkeit, auf dem MCP-Server zu iterieren, ist die Verwendung von `mcp-client/` . Weitere Informationen finden Sie in `mcp-client/README.md` .\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Entwicklung mit Claude Desktop (Lokaler MCP-Server)\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\n**Starten Sie Claude** dann jedes Mal neu, wenn Sie Änderungen testen möchten.\n\n# Testen\n\nUm die Tests auszuführen, müssen Sie die `.env` Datei entsprechend der `.env.example` -Datei einrichten.\n\n```bash\nnpm run test\n```","German","tag","de-DE",{"_27":39,"_31":42,"_36":43},{"_29":40,"_31":32,"_33":41},"Lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things with [Neon](https://neon.tech/).","

\n\n# Neon MCP Server\n\n**Neon MCP Server** is an open-source tool that lets you interact with your Neon Postgres databases in **natural language**.\n\n[![npm version](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon)\n[![npm downloads](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![smithery badge](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\nThe Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) designed to manage context between large language models (LLMs) and external systems. This repository offers an installer and an MCP Server for [Neon](https://neon.tech).\n\nNeon's MCP server acts as a bridge between natural language requests and the [Neon API](https://api-docs.neon.tech/reference/getting-started-with-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.\n\nSome of the key features of the Neon MCP server include:\n\n- **Natural language interaction:** Manage Neon databases using intuitive, conversational commands.\n- **Simplified database management:** Perform complex actions without writing SQL or directly using the Neon API.\n- **Accessibility for non-developers:** Empower users with varying technical backgrounds to interact with Neon databases.\n- **Database migration support:** Leverage Neon's branching capabilities for database schema changes initiated via natural language.\n\nFor example, in Claude Desktop, or any MCP Client, you can use natural language to accomplish things with Neon, such as:\n\n- `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.`\n- `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\".`\n- `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> [!NOTE] \n> 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.\n\n## Setting up Neon MCP Server\n\nYou have two options for connecting your MCP client to Neon:\n\n1. **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.\n\n2. **Local MCP Server:** Run the Neon MCP server locally on your machine, authenticating with a Neon API key.\n\n## Prerequisites\n\n- An MCP Client application.\n- A [Neon account](https://console.neon.tech/signup).\n- **Node.js (>= v18.0.0) and npm:** Download from [nodejs.org](https://nodejs.org).\n\nFor Local MCP Server setup, you also need a Neon API key. See [Neon API Keys documentation](https://neon.tech/docs/manage/api-keys) for instructions on generating one.\n\n### Option 1. Remote Hosted MCP Server (Preview)\n\nConnect 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.\n\n- Add the following \"Neon\" entry to your client's MCP server configuration file (e.g., `mcp.json`, `mcp_config.json`):\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n- Save the configuration file.\n- Restart or refresh your MCP client.\n- An OAuth window will open in your browser. Follow the prompts to authorize your MCP client to access your Neon account.\n\n### Option 2. Local MCP Server\n\nRun the Neon MCP server on your local machine.\n\n**Setup via Smithery:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nYou will be prompted to enter your Neon API key. Enter the API key which you obtained from the [prerequisites](#prerequisites) section\nReplace `` with the name of your MCP client application. Supported client names include:\n\n- `claude` for [Claude Desktop](https://claude.ai/download)\n- `cursor` for [Cursor](https://cursor.com) (Installing via `smithery` makes the MCP server a global MCP server in Cursor)\n- `windsurf` for [Windsurf Editor](https://codeium.com/windsurf)\n- `roo-cline` for [Roo Cline VS Code extension](https://github.com/RooVetGit/Roo-Code)\n- `witsy` for [Witsy](https://witsyai.com/)\n- `enconvo` for [Enconvo](https://www.enconvo.com/)\n- `vscode` for [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\n\nRestart your MCP client after installation.\n\n**Setup via npm**\n\nIf your MCP client is not listed here, you can manually add the Neon MCP Server details to your client's `mcp_config` file.\n\nAdd the following JSON configuration within the `mcpServers` section of your client's `mcp_config` file, replacing `` with your actual Neon API key:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Troubleshooting\n\nIf 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:\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Troubleshooting on Windows\n\nIf 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:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## Guides\n\n- [Neon MCP Server Guide](https://neon.tech/docs/ai/neon-mcp-server)\n- [Connect MCP Clients to Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n- [Cursor with Neon MCP Server](https://neon.tech/guides/cursor-mcp-neon)\n- [Claude Desktop with Neon MCP Server](https://neon.tech/guides/neon-mcp-server)\n- [Cline with Neon MCP Server](https://neon.tech/guides/cline-mcp-neon)\n- [Windsurf with Neon MCP Server](https://neon.tech/guides/windsurf-mcp-neon)\n- [Zed with Neon MCP Server](https://neon.tech/guides/zed-mcp-neon)\n\n# Features\n\n## Supported Tools\n\nThe 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.\n\n**Project Management:**\n\n- **`list_projects`**: Retrieves a list of your Neon projects, providing a summary of each project associated with your Neon account. Supports limiting the number of projects returned (default: 10).\n- **`describe_project`**: Fetches detailed information about a specific Neon project, including its ID, name, and associated branches and databases.\n- **`create_project`**: Creates a new Neon project in your Neon account. A project acts as a container for branches, databases, roles, and computes.\n- **`delete_project`**: Deletes an existing Neon project and all its associated resources.\n\n**Branch Management:**\n\n- **`create_branch`**: Creates a new branch within a specified Neon project. Leverages [Neon's branching](/docs/introduction/branching) feature for development, testing, or migrations.\n- **`delete_branch`**: Deletes an existing branch from a Neon project.\n- **`describe_branch`**: Retrieves details about a specific branch, such as its name, ID, and parent branch.\n- **`list_branch_computes`**: Lists compute endpoints for a project or specific branch, including compute ID, type, size, and autoscaling information.\n\n**SQL Query Execution:**\n\n- **`get_connection_string`**: Returns your database connection string.\n- **`run_sql`**: Executes a single SQL query against a specified Neon database. Supports both read and write operations.\n- **`run_sql_transaction`**: Executes a series of SQL queries within a single transaction against a Neon database.\n- **`get_database_tables`**: Lists all tables within a specified Neon database.\n- **`describe_table_schema`**: Retrieves the schema definition of a specific table, detailing columns, data types, and constraints.\n- **`list_slow_queries`**: Identifies performance bottlenecks by finding the slowest queries in a database. Requires the pg_stat_statements extension.\n\n**Database Migrations (Schema Changes):**\n\n- **`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.\n- **`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.\n\n**Query Performance Tuning:**\n\n- **`explain_sql_statement`**: Analyzes a SQL query and returns detailed execution plan information to help understand query performance.\n- **`prepare_query_tuning`**: Identifies potential performance issues in a SQL query and suggests optimizations. Creates a temporary branch for testing improvements.\n- **`complete_query_tuning`**: Finalizes and applies query optimizations after testing. Merges changes from the temporary tuning branch to the main branch.\n\n**Neon Auth:**\n\n- **`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`).\n\n## Migrations\n\nMigrations 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.\n\nThe \"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.\n\n# Development\n\n## Development with MCP CLI Client\n\nThe easiest way to iterate on the MCP Server is using the `mcp-client/`. Learn more in `mcp-client/README.md`.\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Development with Claude Desktop (Local MCP Server)\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\nThen, **restart Claude** each time you want to test changes.\n\n# Testing\n\nTo run the tests you need to setup the `.env` file according to the `.env.example` file.\n\n```bash\nnpm run test\n```\n","English","en-US",{"_27":45,"_31":49,"_36":50},{"_29":46,"_31":47,"_33":48},"Le permite utilizar Claude Desktop, o cualquier cliente MCP, para utilizar lenguaje natural para lograr cosas con [Neon](https://neon.tech/) .","servidor mcp-neon","# Servidor Neon MCP\n\n**Neon MCP Server** es una herramienta de código abierto que le permite interactuar con sus bases de datos Neon Postgres en **lenguaje natural** .\n\n[![versión npm](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![Descargas de npm](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![Licencia: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![insignia de herrería](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\nEl Protocolo de Contexto de Modelo (MCP) es un [nuevo protocolo estandarizado](https://modelcontextprotocol.io/introduction) 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](https://neon.tech) .\n\nEl servidor MCP de Neon actúa como puente entre las solicitudes en lenguaje natural y la [API de Neon](https://api-docs.neon.tech/reference/getting-started-with-neon-api) . 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.\n\nAlgunas de las características clave del servidor Neon MCP incluyen:\n\n* **Interacción en lenguaje natural:** administre las bases de datos de Neon utilizando comandos conversacionales intuitivos.\n* **Gestión de bases de datos simplificada:** realice acciones complejas sin escribir SQL o utilizando directamente la API de Neon.\n* **Accesibilidad para quienes no son desarrolladores:** permita a los usuarios con distintos antecedentes técnicos interactuar con las bases de datos de Neon.\n* **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.\n\nPor ejemplo, en Claude Desktop o cualquier cliente MCP, puedes usar lenguaje natural para lograr cosas con Neon, como:\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[!NOTA]\\\n> 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.\n\n## Configuración del servidor Neon MCP\n\nTiene dos opciones para conectar su cliente MCP a Neon:\n\n1. **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.\n\n2. **Servidor MCP local:** ejecute el servidor MCP de Neon localmente en su máquina, autenticándose con una clave API de Neon.\n\n## Prerrequisitos\n\n* Una aplicación cliente MCP.\n* Una [cuenta Neon](https://console.neon.tech/signup) .\n* **Node.js (>= v18.0.0) y npm:** Descargar desde [nodejs.org](https://nodejs.org) .\n\nPara configurar el servidor MCP local, también necesita una clave API de Neon. Consulte [la documentación de claves API de Neon](https://neon.tech/docs/manage/api-keys) para obtener instrucciones sobre cómo generarla.\n\n### Opción 1. Servidor MCP alojado remotamente (versión preliminar)\n\nConé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.\n\n* Agregue la siguiente entrada \"Neon\" al archivo de configuración del servidor MCP de su cliente (por ejemplo, `mcp.json` , `mcp_config.json` ):\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n* Guarde el archivo de configuración.\n\n* Reinicie o actualice su cliente MCP.\n\n* 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.\n\n### Opción 2. Servidor MCP local\n\nEjecute el servidor Neon MCP en su máquina local.\n\n**Configuración a través de Smithery:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nSe le solicitará que ingrese su clave de API de Neon. Ingrese la clave de API que obtuvo en la sección [de prerrequisitos.](#prerequisites) Reemplace `` por el nombre de su aplicación cliente de MCP. Los nombres de cliente compatibles incluyen:\n\n* `claude` para [Claude Desktop](https://claude.ai/download)\n* `cursor` para [Cursor](https://cursor.com) (La instalación mediante `smithery` convierte al servidor MCP en un servidor MCP global en Cursor)\n* `windsurf` para [Windsurf Editor](https://codeium.com/windsurf)\n* `roo-cline` para [la extensión Roo Cline VS Code](https://github.com/RooVetGit/Roo-Code)\n* `witsy` para [ingenioso](https://witsyai.com/)\n* `enconvo` para [Enconvo](https://www.enconvo.com/)\n* `vscode` para [Visual Studio Code (versión preliminar)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\n\nReinicie su cliente MCP después de la instalación.\n\n**Configuración a través de npm**\n\nSi su cliente MCP no aparece aquí, puede agregar manualmente los detalles del servidor Neon MCP al archivo `mcp_config` de su cliente.\n\nAgregue la siguiente configuración JSON dentro de la sección `mcpServers` del archivo `mcp_config` de su cliente, reemplazando `` con su clave API de Neon real:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Solución de problemas\n\nSi 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:\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Solución de problemas en Windows\n\nSi 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:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## Guías\n\n* [Guía del servidor Neon MCP](https://neon.tech/docs/ai/neon-mcp-server)\n* [Conectar clientes MCP a Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [Cursor con servidor Neon MCP](https://neon.tech/guides/cursor-mcp-neon)\n* [Escritorio Claude con servidor Neon MCP](https://neon.tech/guides/neon-mcp-server)\n* [Cline con servidor Neon MCP](https://neon.tech/guides/cline-mcp-neon)\n* [Windsurf con el servidor Neon MCP](https://neon.tech/guides/windsurf-mcp-neon)\n* [Zed con servidor Neon MCP](https://neon.tech/guides/zed-mcp-neon)\n\n# Características\n\n## Herramientas compatibles\n\nEl 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.\n\n**Gestión de proyectos:**\n\n* **`list_projects`** : Obtiene una lista de sus proyectos de Neon, con un resumen de cada proyecto asociado a su cuenta. Permite limitar el número de proyectos devueltos (predeterminado: 10).\n* **`describe_project`** : obtiene información detallada sobre un proyecto Neon específico, incluido su ID, nombre y ramas y bases de datos asociadas.\n* **`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.\n* **`delete_project`** : elimina un proyecto Neon existente y todos sus recursos asociados.\n\n**Gestión de sucursales:**\n\n* **`create_branch`** : Crea una nueva rama dentro de un proyecto Neon específico. Aprovecha la función [de ramificación de Neon](/docs/introduction/branching) para desarrollo, pruebas o migraciones.\n* **`delete_branch`** : elimina una rama existente de un proyecto Neon.\n* **`describe_branch`** : recupera detalles sobre una rama específica, como su nombre, ID y rama principal.\n* **`list_branch_computes`** : enumera los puntos finales de cómputo para un proyecto o una rama específica, incluido el ID de cómputo, el tipo, el tamaño y la información de escalamiento automático.\n\n**Ejecución de consulta SQL:**\n\n* **`get_connection_string`** : Devuelve la cadena de conexión a su base de datos.\n* **`run_sql`** : Ejecuta una única consulta SQL en una base de datos Neon especificada. Admite operaciones de lectura y escritura.\n* **`run_sql_transaction`** : ejecuta una serie de consultas SQL dentro de una sola transacción contra una base de datos Neon.\n* **`get_database_tables`** : enumera todas las tablas dentro de una base de datos Neon especificada.\n* **`describe_table_schema`** : recupera la definición del esquema de una tabla específica, detallando columnas, tipos de datos y restricciones.\n* **`list_slow_queries`** : Identifica cuellos de botella de rendimiento al encontrar las consultas más lentas en una base de datos. Requiere la extensión pg\\_stat\\_statements.\n\n**Migraciones de bases de datos (cambios de esquema):**\n\n* **`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.\n* **`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.\n\n**Ajuste del rendimiento de las consultas:**\n\n* **`explain_sql_statement`** : analiza una consulta SQL y devuelve información detallada del plan de ejecución para ayudar a comprender el rendimiento de la consulta.\n* **`prepare_query_tuning`** : Identifica posibles problemas de rendimiento en una consulta SQL y sugiere optimizaciones. Crea una rama temporal para probar mejoras.\n* **`complete_query_tuning`** : Finaliza y aplica las optimizaciones de consulta tras las pruebas. Fusiona los cambios de la rama de ajuste temporal con la rama principal.\n\n**Autorización de neón:**\n\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` ).\n\n## Migraciones\n\nLas 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` ).\n\nEl 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.\n\n# Desarrollo\n\n## Desarrollo con cliente CLI de MCP\n\nLa forma más sencilla de iterar en el servidor MCP es mediante `mcp-client/` . Obtenga más información en `mcp-client/README.md` .\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Desarrollo con Claude Desktop (Servidor MCP local)\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\nLuego, **reinicie Claude** cada vez que desee probar los cambios.\n\n# Pruebas\n\nPara ejecutar las pruebas es necesario configurar el archivo `.env` de acuerdo con el archivo `.env.example` .\n\n```bash\nnpm run test\n```","Spanish","es-ES",{"_27":52,"_31":55,"_36":56},{"_29":53,"_31":32,"_33":54},"Claude Desktop または任意の MCP クライアントを使用して、自然言語で[Neon](https://neon.tech/)の操作を実行できます。","# ネオンMCPサーバー\n\n**Neon MCP Server は、** **自然言語**で Neon Postgres データベースと対話できるオープンソースツールです。\n\n[![npmバージョン](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![npmダウンロード](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![ライセンス: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![鍛冶屋のバッジ](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\nモデルコンテキストプロトコル（MCP）は、大規模言語モデル（LLM）と外部システム間のコンテキストを管理するために設計された[新しい標準化プロトコル](https://modelcontextprotocol.io/introduction)です。このリポジトリには、 [Neon](https://neon.tech)用のインストーラーとMCPサーバーが含まれています。\n\nNeonのMCPサーバーは、自然言語リクエストと[Neon API](https://api-docs.neon.tech/reference/getting-started-with-neon-api)間の橋渡しとして機能します。MCP上に構築されたこのサーバーは、リクエストを必要なAPI呼び出しに変換し、プロジェクトやブランチの作成、クエリの実行、データベースの移行といったタスクをシームレスに管理できるようにします。\n\nNeon MCP サーバーの主な機能は次のとおりです。\n\n* \\*\\*自然言語によるインタラクション:\\*\\*直感的な会話型コマンドを使用して Neon データベースを管理します。\n* **簡素化されたデータベース管理:** SQL を記述したり、Neon API を直接使用したりすることなく、複雑なアクションを実行します。\n* \\*\\*開発者以外のユーザーもアクセス可能:\\*\\*さまざまな技術的背景を持つユーザーが Neon データベースを操作できるようにします。\n* \\*\\*データベース移行のサポート:\\*\\*自然言語で開始されたデータベーススキーマの変更に Neon の分岐機能を活用します。\n\nたとえば、Claude Desktop または任意の MCP クライアントでは、自然言語を使用して、次のようなことを Neon で実行できます。\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[！注記]\\\n> Neon MCPサーバーは、自然言語リクエストを通じて強力なデータベース管理機能を提供します。LLMによって要求された**アクションは、実行前に必ず確認し、承認してください**。承認されたユーザーとアプリケーションのみがNeon MCPサーバーとNeon APIキーにアクセスできるようにしてください。\n\n## Neon MCPサーバーの設定\n\nMCP クライアントを Neon に接続するには、次の 2 つのオプションがあります。\n\n1. **リモートMCPサーバー（プレビュー）：** OAuth認証を使用して、Neonが管理するMCPサーバーに接続します。この方法はAPIキーの管理が不要で、より便利です。さらに、最新の機能や改善がリリースされるとすぐに自動的に通知されます。\n\n2. **ローカル MCP サーバー:** Neon API キーで認証して、マシン上でローカルに Neon MCP サーバーを実行します。\n\n## 前提条件\n\n* MCP クライアントアプリケーション。\n* [Neonアカウント](https://console.neon.tech/signup)。\n* **Node.js (>= v18.0.0) および npm:** [nodejs.org](https://nodejs.org)からダウンロードします。\n\nローカルMCPサーバーのセットアップには、Neon APIキーも必要です。生成手順については、 [Neon APIキーのドキュメントを](https://neon.tech/docs/manage/api-keys)ご覧ください。\n\n### オプション 1. リモートホスト MCP サーバー (プレビュー)\n\nOAuth認証を使用して、NeonのマネージドMCPサーバーに接続します。これは最も簡単な設定で、サーバーのローカルインストールは不要で、クライアントでNeon APIキーを設定する必要もありません。\n\n* クライアントの MCP サーバー構成ファイル (例: `mcp.json` 、 `mcp_config.json` ) に次の「Neon」エントリを追加します。\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n* 設定ファイルを保存します。\n\n* MCP クライアントを再起動または更新します。\n\n* ブラウザにOAuthウィンドウが開きます。指示に従って、MCPクライアントがNeonアカウントにアクセスできるように承認してください。\n\n### オプション2. ローカルMCPサーバー\n\nローカルマシンで Neon MCP サーバーを実行します。\n\n**Smithery 経由のセットアップ:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nNeon APIキーの入力を求められます。[前提条件](#prerequisites)セクションで取得したAPIキーを入力してください。 `` MCPクライアントアプリケーションの名前に置き換えてください。サポートされているクライアント名は次のとおりです。\n\n* [クロードデスクトップ](https://claude.ai/download)の`claude`\n* [Cursor](https://cursor.com)用の`cursor` ( `smithery`経由でインストールすると、MCP サーバーが Cursor のグローバル MCP サーバーになります)\n* [Windsurf Editor](https://codeium.com/windsurf)の`windsurf`\n* [Roo Cline VS Code 拡張機能](https://github.com/RooVetGit/Roo-Code)の`roo-cline`\n* [ウィッツィー](https://witsyai.com/)のための`witsy`\n* [Enconvo](https://www.enconvo.com/)の`enconvo`\n* [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)用の`vscode` (プレビュー)\n\nインストール後に MCP クライアントを再起動します。\n\n**npm経由でセットアップ**\n\nMCP クライアントがここにリストされていない場合は、クライアントの`mcp_config`ファイルに Neon MCP サーバーの詳細を手動で追加できます。\n\nクライアントの`mcp_config`ファイルの`mcpServers`セクション内に次の JSON 構成を追加し、 ``実際の Neon API キーに置き換えます。\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### トラブルシューティング\n\nクライアントが MCP サーバーの構成に`JSON`を使用していない場合は (古いバージョンの Cursor など)、プロンプトが表示されたときに次のコマンドを使用できます。\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Windowsでのトラブルシューティング\n\nWindowsをご利用で、MCPサーバーの追加中に問題が発生した場合、コマンドプロンプト（ `cmd` ）またはWindows Subsystem for Linux（ `wsl` ）を使用して必要なコマンドを実行する必要がある場合があります。設定は以下のようになります。\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## ガイド\n\n* [Neon MCP サーバーガイド](https://neon.tech/docs/ai/neon-mcp-server)\n* [MCPクライアントをNeonに接続する](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [Neon MCP サーバーを使用したカーソル](https://neon.tech/guides/cursor-mcp-neon)\n* [Claude デスクトップと Neon MCP サーバー](https://neon.tech/guides/neon-mcp-server)\n* [Neon MCP サーバーを使用した Cline](https://neon.tech/guides/cline-mcp-neon)\n* [Neon MCP サーバーでウィンドサーフィン](https://neon.tech/guides/windsurf-mcp-neon)\n* [Neon MCP サーバーを使用した Zed](https://neon.tech/guides/zed-mcp-neon)\n\n# 特徴\n\n## サポートされているツール\n\nNeon MCPサーバーは、MCPクライアントに「ツール」として公開される以下のアクションを提供します。これらのツールを使用することで、自然言語コマンドを使用してNeonプロジェクトやデータベースを操作できます。\n\n**プロジェクト管理：**\n\n* **`list_projects`** : Neonプロジェクトのリストを取得し、Neonアカウントに関連付けられた各プロジェクトの概要を表示します。返されるプロジェクトの数を制限できます（デフォルト：10）。\n* **`describe_project`** : 特定の Neon プロジェクトの ID、名前、関連するブランチやデータベースなどの詳細情報を取得します。\n* **`create_project`** : Neonアカウントに新しいNeonプロジェクトを作成します。プロジェクトは、ブランチ、データベース、ロール、コンピューティングのコンテナとして機能します。\n* **`delete_project`** : 既存の Neon プロジェクトとそれに関連付けられたすべてのリソースを削除します。\n\n**支店管理:**\n\n* **`create_branch`** : 指定された Neon プロジェクト内に新しいブランチを作成します。開発、テスト、移行に[Neon のブランチ](/docs/introduction/branching)機能を活用します。\n* **`delete_branch`** : Neon プロジェクトから既存のブランチを削除します。\n* **`describe_branch`** : 特定のブランチの名前、ID、親ブランチなどの詳細を取得します。\n* **`list_branch_computes`** : コンピューティング ID、タイプ、サイズ、自動スケーリング情報など、プロジェクトまたは特定のブランチのコンピューティングエンドポイントを一覧表示します。\n\n**SQLクエリ実行:**\n\n* **`get_connection_string`** : データベース接続文字列を返します。\n* **`run_sql`** : 指定されたNeonデータベースに対して単一のSQLクエリを実行します。読み取りと書き込みの両方の操作をサポートします。\n* **`run_sql_transaction`** : Neon データベースに対して、単一のトランザクション内で一連の SQL クエリを実行します。\n* **`get_database_tables`** : 指定された Neon データベース内のすべてのテーブルを一覧表示します。\n* **`describe_table_schema`** : 特定のテーブルのスキーマ定義を取得し、列、データ型、制約の詳細を示します。\n* **`list_slow_queries`** : データベース内で最も遅いクエリを見つけることで、パフォーマンスのボトルネックを特定します。pg\\_stat\\_statements 拡張機能が必要です。\n\n**データベースの移行 (スキーマの変更):**\n\n* **`prepare_database_migration`** : データベース移行プロセスを開始します。重要なのは、メインブランチに影響を与える前に、移行を安全に適用してテストするための一時ブランチを作成することです。\n* **`complete_database_migration`** : 準備済みのデータベース移行を完了し、メインブランチに適用します。このアクションは、一時的な移行ブランチからの変更をマージし、一時的なリソースをクリーンアップします。\n\n**クエリパフォーマンスのチューニング:**\n\n* **`explain_sql_statement`** : SQL クエリを分析し、クエリのパフォーマンスを理解するのに役立つ詳細な実行プラン情報を返します。\n* **`prepare_query_tuning`** : SQLクエリの潜在的なパフォーマンス問題を特定し、最適化を提案します。改善をテストするための一時ブランチを作成します。\n* **`complete_query_tuning`** : テスト後にクエリの最適化を確定し、適用します。一時的なチューニングブランチからメインブランチに変更をマージします。\n\n**ネオン認証:**\n\n* **`provision_neon_auth`** : NeonプロジェクトにNeon Authをプロビジョニングするアクション。開発者はStack Auth ( `@stackframe/stack` )との統合を作成することで、認証インフラストラクチャを簡単にセットアップできます。\n\n## 移行\n\nマイグレーションは、データベーススキーマへの変更を時間の経過とともに管理する方法です。Neon MCPサーバーでは、LLMは「開始」（ `prepare_database_migration` ）コマンドと「コミット」（ `complete_database_migration` ）コマンドを別々に実行することで、安全にマイグレーションを実行できます。\n\n「Start」コマンドはマイグレーションを受け取り、新しい一時ブランチで実行します。コマンドが戻ると、LLMにこのブランチでマイグレーションをテストする必要があることを通知します。LLMはその後、「Commit」コマンドを実行し、マイグレーションを元のブランチに適用します。\n\n# 発達\n\n## MCP CLI クライアントを使用した開発\n\nMCPサーバーで反復処理を行う最も簡単な方法は`mcp-client/`を使用することです。詳細については`mcp-client/README.md`を参照してください。\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Claude Desktop（ローカルMCPサーバー）を使用した開発\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\nその後、変更をテストするたびに**Claude を再起動します**。\n\n# テスト\n\nテストを実行するには、 `.env.example`ファイルに従って`.env`ファイルを設定する必要があります。\n\n```bash\nnpm run test\n```","Japanese","ja-JP",{"_27":58,"_31":62,"_36":63},{"_29":59,"_31":60,"_33":61},"Claude Desktop이나 모든 MCP 클라이언트를 사용하여 [Neon](https://neon.tech/) 으로 자연어를 사용하여 작업을 수행할 수 있습니다.","mcp-서버-네온","# 네온 MCP 서버\n\n**Neon MCP 서버는** **자연어** 로 Neon Postgres 데이터베이스와 상호 작용할 수 있는 오픈 소스 도구입니다.\n\n[![npm 버전](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![npm 다운로드](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![라이센스: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![대장간 배지](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\n모델 컨텍스트 프로토콜(MCP)은 대규모 언어 모델(LLM)과 외부 시스템 간의 컨텍스트를 관리하도록 설계된 [새로운 표준화된 프로토콜](https://modelcontextprotocol.io/introduction) 입니다. 이 저장소는 [Neon](https://neon.tech) 용 설치 프로그램과 MCP 서버를 제공합니다.\n\nNeon의 MCP 서버는 자연어 요청과 [Neon API를](https://api-docs.neon.tech/reference/getting-started-with-neon-api) 연결하는 다리 역할을 합니다. MCP 기반으로 구축된 이 서버는 요청을 필요한 API 호출로 변환하여 프로젝트 및 브랜치 생성, 쿼리 실행, 데이터베이스 마이그레이션 등의 작업을 원활하게 관리할 수 있도록 지원합니다.\n\nNeon MCP 서버의 주요 기능은 다음과 같습니다.\n\n* **자연어 상호작용:** 직관적인 대화형 명령을 사용하여 Neon 데이터베이스를 관리합니다.\n* **간소화된 데이터베이스 관리:** SQL을 작성하거나 Neon API를 직접 사용하지 않고도 복잡한 작업을 수행할 수 있습니다.\n* **비개발자를 위한 접근성:** 다양한 기술적 배경을 가진 사용자가 Neon 데이터베이스와 상호 작용할 수 있도록 지원합니다.\n* **데이터베이스 마이그레이션 지원:** 자연어를 통해 시작된 데이터베이스 스키마 변경에 대해 Neon의 분기 기능을 활용합니다.\n\n예를 들어, Claude Desktop이나 모든 MCP 클라이언트에서 Neon을 사용하여 다음과 같은 작업을 수행할 수 있습니다.\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[!메모]\\\n> Neon MCP 서버는 자연어 요청을 통해 강력한 데이터베이스 관리 기능을 제공합니다. LLM에서 요청한 **작업을 실행하기 전에 항상 검토하고 권한을 부여하십시오** . 권한이 있는 사용자와 애플리케이션만 Neon MCP 서버와 Neon API 키에 액세스할 수 있도록 하십시오.\n\n## Neon MCP 서버 설정\n\nMCP 클라이언트를 Neon에 연결하는 데는 두 가지 옵션이 있습니다.\n\n1. **원격 MCP 서버(미리보기):** OAuth 인증을 사용하여 Neon의 관리형 MCP 서버에 연결합니다. 이 방법은 API 키를 관리할 필요가 없어 더욱 편리합니다. 또한, 최신 기능 및 개선 사항이 출시되는 즉시 자동으로 제공됩니다.\n\n2. **로컬 MCP 서버:** Neon API 키로 인증하여 로컬 컴퓨터에서 Neon MCP 서버를 실행합니다.\n\n## 필수 조건\n\n* MCP 클라이언트 애플리케이션.\n* [네온 계정](https://console.neon.tech/signup) .\n* **Node.js (>= v18.0.0) 및 npm:** [nodejs.org](https://nodejs.org) 에서 다운로드하세요.\n\n로컬 MCP 서버 설정에는 Neon API 키도 필요합니다. Neon API 키 생성 방법은 [Neon API 키 설명서를](https://neon.tech/docs/manage/api-keys) 참조하세요.\n\n### 옵션 1. 원격 호스팅 MCP 서버(미리 보기)\n\nOAuth 인증을 사용하여 Neon의 관리형 MCP 서버에 연결합니다. 이 설정은 가장 간편하며, 서버를 로컬에 설치할 필요가 없고, 클라이언트에 Neon API 키를 구성할 필요도 없습니다.\n\n* 클라이언트의 MCP 서버 구성 파일(예: `mcp.json` , `mcp_config.json` )에 다음 \"Neon\" 항목을 추가합니다.\n\n 지엑스피1\n\n* 구성 파일을 저장합니다.\n\n* MCP 클라이언트를 다시 시작하거나 새로 고칩니다.\n\n* 브라우저에 OAuth 창이 열립니다. 안내에 따라 MCP 클라이언트가 Neon 계정에 액세스할 수 있도록 권한을 부여하세요.\n\n### 옵션 2. 로컬 MCP 서버\n\n로컬 컴퓨터에서 Neon MCP 서버를 실행합니다.\n\n**Smithery를 통한 설정:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nNeon API 키를 입력하라는 메시지가 표시됩니다. [필수 구성 요소](#prerequisites) 섹션에서 받은 API 키를 입력하세요. `` MCP 클라이언트 애플리케이션 이름으로 바꾸세요. 지원되는 클라이언트 이름은 다음과 같습니다.\n\n* Claude [데스크탑](https://claude.ai/download) 용 `claude`\n* [Cursor](https://cursor.com) 용 `cursor` ( `smithery` 통해 설치하면 MCP 서버가 Cursor의 글로벌 MCP 서버가 됨)\n* [Windsurf Editor를](https://codeium.com/windsurf) 위한 `windsurf`\n* [Roo Cline VS Code 확장을](https://github.com/RooVetGit/Roo-Code) 위한 `roo-cline`\n* [위티](https://witsyai.com/) 를 위한 `witsy`\n* [enconvo](https://www.enconvo.com/) 를 위한 `enconvo`\n* [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) 용 `vscode` (미리 보기)\n\n설치 후 MCP 클라이언트를 다시 시작하세요.\n\n**npm을 통한 설정**\n\n여기에 귀하의 MCP 클라이언트가 나열되어 있지 않으면 Neon MCP 서버 세부 정보를 클라이언트의 `mcp_config` 파일에 수동으로 추가할 수 있습니다.\n\n클라이언트의 `mcp_config` 파일에 있는 `mcpServers` 섹션에 다음 JSON 구성을 추가하고 `` 실제 Neon API 키로 바꿉니다.\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### 문제 해결\n\n클라이언트가 MCP 서버 구성에 `JSON` 사용하지 않는 경우(예: 이전 버전의 Cursor), 메시지가 표시되면 다음 명령을 사용할 수 있습니다.\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Windows에서 문제 해결\n\nWindows를 사용 중이고 MCP 서버를 추가하는 동안 문제가 발생하는 경우, 명령 프롬프트( `cmd` ) 또는 Linux용 Windows 하위 시스템( `wsl` )을 사용하여 필요한 명령을 실행해야 할 수 있습니다. 구성 설정은 다음과 유사할 수 있습니다.\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## 가이드\n\n* [Neon MCP 서버 가이드](https://neon.tech/docs/ai/neon-mcp-server)\n* [MCP 클라이언트를 Neon에 연결](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [Neon MCP 서버를 사용한 커서](https://neon.tech/guides/cursor-mcp-neon)\n* [Neon MCP 서버가 포함된 Claude Desktop](https://neon.tech/guides/neon-mcp-server)\n* [Neon MCP 서버를 사용하는 Cline](https://neon.tech/guides/cline-mcp-neon)\n* [Neon MCP 서버를 사용한 윈드서핑](https://neon.tech/guides/windsurf-mcp-neon)\n* [Neon MCP 서버가 있는 Zed](https://neon.tech/guides/zed-mcp-neon)\n\n# 특징\n\n## 지원되는 도구\n\nNeon MCP 서버는 MCP 클라이언트에 \"도구\"로 제공되는 다음과 같은 작업을 제공합니다. 이러한 도구를 사용하면 자연어 명령을 사용하여 Neon 프로젝트 및 데이터베이스와 상호 작용할 수 있습니다.\n\n**프로젝트 관리:**\n\n* **`list_projects`** : Neon 프로젝트 목록을 검색하여 Neon 계정과 연결된 각 프로젝트의 요약을 제공합니다. 반환되는 프로젝트 수를 제한할 수 있습니다(기본값: 10개).\n* **`describe_project`** : ID, 이름, 관련 브랜치 및 데이터베이스를 포함하여 특정 Neon 프로젝트에 대한 자세한 정보를 가져옵니다.\n* **`create_project`** : Neon 계정에 새 Neon 프로젝트를 생성합니다. 프로젝트는 브랜치, 데이터베이스, 역할 및 컴퓨팅을 위한 컨테이너 역할을 합니다.\n* **`delete_project`** : 기존 Neon 프로젝트와 관련 리소스를 모두 삭제합니다.\n\n**지점 관리:**\n\n* **`create_branch`** : 지정된 Neon 프로젝트 내에 새 브랜치를 생성합니다. 개발, 테스트 또는 마이그레이션에 [Neon의 브랜치](/docs/introduction/branching) 기능을 활용합니다.\n* **`delete_branch`** : Neon 프로젝트에서 기존 브랜치를 삭제합니다.\n* **`describe_branch`** : 이름, ID, 상위 브랜치 등 특정 브랜치에 대한 세부 정보를 검색합니다.\n* **`list_branch_computes`** : 컴퓨팅 ID, 유형, 크기 및 자동 확장 정보를 포함하여 프로젝트 또는 특정 브랜치에 대한 컴퓨팅 엔드포인트를 나열합니다.\n\n**SQL 쿼리 실행:**\n\n* **`get_connection_string`** : 데이터베이스 연결 문자열을 반환합니다.\n* **`run_sql`** : 지정된 Neon 데이터베이스에 대해 단일 SQL 쿼리를 실행합니다. 읽기 및 쓰기 작업을 모두 지원합니다.\n* **`run_sql_transaction`** : Neon 데이터베이스에 대해 단일 트랜잭션 내에서 일련의 SQL 쿼리를 실행합니다.\n* **`get_database_tables`** : 지정된 Neon 데이터베이스 내의 모든 테이블을 나열합니다.\n* **`describe_table_schema`** : 특정 테이블의 스키마 정의를 검색하여 열, 데이터 유형, 제약 조건을 자세히 설명합니다.\n* **`list_slow_queries`** : 데이터베이스에서 가장 느린 쿼리를 찾아 성능 병목 현상을 파악합니다. pg\\_stat\\_statements 확장이 필요합니다.\n\n**데이터베이스 마이그레이션(스키마 변경):**\n\n* **`prepare_database_migration`** : 데이터베이스 마이그레이션 프로세스를 시작합니다. 중요한 점은 메인 브랜치에 영향을 주기 전에 마이그레이션을 안전하게 적용하고 테스트할 임시 브랜치를 생성한다는 것입니다.\n* **`complete_database_migration`** : 준비된 데이터베이스 마이그레이션을 완료하고 메인 브랜치에 적용합니다. 이 작업은 임시 마이그레이션 브랜치의 변경 사항을 병합하고 임시 리소스를 정리합니다.\n\n**쿼리 성능 튜닝:**\n\n* **`explain_sql_statement`** : SQL 쿼리를 분석하고 쿼리 성능을 이해하는 데 도움이 되는 자세한 실행 계획 정보를 반환합니다.\n* **`prepare_query_tuning`** : SQL 쿼리의 잠재적 성능 문제를 파악하고 최적화 방안을 제안합니다. 개선 사항 테스트를 위한 임시 브랜치를 생성합니다.\n* **`complete_query_tuning`** : 테스트 후 쿼리 최적화를 완료하고 적용합니다. 임시 튜닝 브랜치의 변경 사항을 기본 브랜치에 병합합니다.\n\n**네온 인증:**\n\n* **`provision_neon_auth`** : Neon 프로젝트에 Neon Auth를 프로비저닝하는 작업입니다. 개발자는 Stack Auth( `@stackframe/stack` )와 통합하여 인증 인프라를 쉽게 설정할 수 있습니다.\n\n## 이주\n\n마이그레이션은 시간 경과에 따른 데이터베이스 스키마 변경 사항을 관리하는 방법입니다. Neon MCP 서버를 사용하면 LLM은 별도의 \"시작\"( `prepare_database_migration` ) 및 \"커밋\"( `complete_database_migration` ) 명령을 사용하여 안전하게 마이그레이션을 수행할 수 있습니다.\n\n\"Start\" 명령은 마이그레이션을 수락하고 새 임시 브랜치에서 실행합니다. 이 명령은 LLM에 해당 브랜치에서 마이그레이션을 테스트해야 한다는 힌트를 제공합니다. LLM은 \"Commit\" 명령을 실행하여 마이그레이션을 원래 브랜치에 적용할 수 있습니다.\n\n# 개발\n\n## MCP CLI 클라이언트를 사용한 개발\n\nMCP 서버에서 반복 작업을 수행하는 가장 쉬운 방법은 `mcp-client/` 사용하는 것입니다. 자세한 내용은 `mcp-client/README.md` 참조하세요.\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Claude Desktop(로컬 MCP 서버)을 사용한 개발\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\n그런 다음 변경 사항을 테스트할 때마다 **Claude를 다시 시작합니다** .\n\n# 테스트\n\n테스트를 실행하려면 `.env.example` 파일에 따라 `.env` 파일을 설정해야 합니다.\n\n```bash\nnpm run test\n```","Korean","ko-KR",{"_27":65,"_31":69,"_36":70},{"_29":66,"_31":67,"_33":68},"Позволяет использовать Claude Desktop или любой клиент MCP для использования естественного языка при работе с [Neon](https://neon.tech/) .","mcp-сервер-неон","# Сервер Neon MCP\n\n**Neon MCP Server** — это инструмент с открытым исходным кодом, позволяющий вам взаимодействовать с базами данных Neon Postgres на **естественном языке** .\n\n[![npm-версия](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![npm-загрузки](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![Лицензия: Массачусетский технологический институт](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![значок кузнеца](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\nModel Context Protocol (MCP) — это [новый стандартизированный протокол,](https://modelcontextprotocol.io/introduction) предназначенный для управления контекстом между большими языковыми моделями (LLM) и внешними системами. Этот репозиторий предлагает установщик и сервер MCP для [Neon](https://neon.tech) .\n\nСервер Neon MCP выступает в качестве моста между запросами на естественном языке и [API Neon](https://api-docs.neon.tech/reference/getting-started-with-neon-api) . Созданный на основе MCP, он преобразует ваши запросы в необходимые вызовы API, позволяя вам легко управлять такими задачами, как создание проектов и ветвей, выполнение запросов и миграция баз данных.\n\nНекоторые из ключевых особенностей сервера Neon MCP включают в себя:\n\n* **Взаимодействие на естественном языке:** управляйте базами данных Neon с помощью интуитивно понятных диалоговых команд.\n* **Упрощенное управление базой данных:** выполняйте сложные действия без написания SQL или прямого использования API Neon.\n* **Доступность для неразработчиков:** предоставьте пользователям с различным техническим опытом возможность взаимодействовать с базами данных Neon.\n* **Поддержка миграции базы данных:** используйте возможности ветвления Neon для изменений схемы базы данных, инициированных с помощью естественного языка.\n\nНапример, в Claude Desktop или любом MCP Client вы можете использовать естественный язык для выполнения задач с Neon, таких как:\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[!ПРИМЕЧАНИЕ]\\\n> Сервер Neon MCP предоставляет мощные возможности управления базами данных с помощью запросов на естественном языке. **Всегда проверяйте и авторизуйте действия,** запрошенные LLM, перед выполнением. Убедитесь, что только авторизованные пользователи и приложения имеют доступ к серверу Neon MCP и ключам API Neon.\n\n## Настройка сервера Neon MCP\n\nУ вас есть два варианта подключения вашего клиента MCP к Neon:\n\n1. **Удаленный сервер MCP (предварительная версия):** подключение к управляемому серверу MCP Neon с использованием OAuth для аут��нтификации. Этот метод более удобен, поскольку устраняет необходимость управления ключами API. Кроме того, вы автоматически получите новейшие функции и улучшения, как только они будут выпущены.\n\n2. **Локальный сервер MCP:** запустите сервер Neon MCP локально на своем компьютере, выполнив аутентификацию с помощью ключа API Neon.\n\n## Предпосылки\n\n* Клиентское приложение MCP.\n* [Аккаунт Neon](https://console.neon.tech/signup) .\n* **Node.js (>= v18.0.0) и npm:** загрузить с [nodejs.org](https://nodejs.org) .\n\nДля настройки локального сервера MCP вам также понадобится ключ Neon API. Инструкции по его генерации см. [в документации по ключам Neon API](https://neon.tech/docs/manage/api-keys) .\n\n### Вариант 1. Удаленный сервер MCP (предварительная версия)\n\nПодключитесь к управляемому серверу MCP Neon, используя OAuth для аутентификации. Это самая простая настройка, не требующая локальной установки этого сервера и не требующая ключа API Neon, настроенного в клиенте.\n\n* Добавьте следующую запись «Neon» в файл конфигурации сервера MCP вашего клиента (например, `mcp.json` , `mcp_config.json` ):\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n* Сохраните файл конфигурации.\n\n* Перезапустите или обновите клиент MCP.\n\n* В вашем браузере откроется окно OAuth. Следуйте инструкциям, чтобы авторизовать вашего клиента MCP для доступа к вашей учетной записи Neon.\n\n### Вариант 2. Локальный MCP-сервер\n\nЗапустите сервер Neon MCP на локальном компьютере.\n\n**Настройка через Smithery:**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\nВам будет предложено ввести ключ API Neon. Введите ключ API, который вы получили в разделе [предварительных условий.](#prerequisites) Замените `` на имя вашего клиентского приложения MCP. Поддерживаемые имена клиентов включают:\n\n* `claude` для [рабочего стола Клода](https://claude.ai/download)\n* `cursor` для [курсора](https://cursor.com) (Установка через `smithery` делает сервер MCP глобальным сервером MCP в курсоре)\n* `windsurf` для [редактора Windsurf](https://codeium.com/windsurf)\n* `roo-cline` для [расширения Roo Cline VS Code](https://github.com/RooVetGit/Roo-Code)\n* `witsy` для [остроумный](https://witsyai.com/)\n* `enconvo` для [Enconvo](https://www.enconvo.com/)\n* `vscode` для [Visual Studio Code (предварительная версия)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)\n\nПерезапустите клиент MCP после установки.\n\n**Настройка через npm**\n\nЕсли ваш клиент MCP не указан здесь, вы можете вручную добавить данные сервера Neon MCP в файл `mcp_config` вашего клиента.\n\nДобавьте следующую конфигурацию JSON в раздел `mcpServers` файла `mcp_config` вашего клиента, заменив `` вашим фактическим ключом API Neon:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Поиск неисправностей\n\nЕсли ваш клиент не использует `JSON` для настройки серверов MCP (например, старые версии Cursor), вы можете использовать следующую команду при появлении соответствующего запроса:\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Устранение неполадок в Windows\n\nЕсли вы используете Windows и столкнулись с проблемами при добавлении сервера MCP, вам может потребоваться использовать командную строку ( `cmd` ) или подсистему Windows для Linux ( `wsl` ) для запуска необходимых команд. Ваша настройка конфигурации может выглядеть следующим образом:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## Руководства\n\n* [Руководство по серверу Neon MCP](https://neon.tech/docs/ai/neon-mcp-server)\n* [Подключите клиентов MCP к Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [Курсор с Neon MCP Server](https://neon.tech/guides/cursor-mcp-neon)\n* [Рабочий стол Claude с сервером Neon MCP](https://neon.tech/guides/neon-mcp-server)\n* [Cline с сервером Neon MCP](https://neon.tech/guides/cline-mcp-neon)\n* [Виндсерфинг с сервером Neon MCP](https://neon.tech/guides/windsurf-mcp-neon)\n* [Zed с сервером Neon MCP](https://neon.tech/guides/zed-mcp-neon)\n\n# Функции\n\n## Поддерживаемые инструменты\n\nNeon MCP Server предоставляет следующие действия, которые представлены как «инструменты» для MCP Clients. Вы можете использовать эти инструменты для взаимодействия с вашими проектами и базами данных Neon с помощью команд естественного языка.\n\n**Управление проектом:**\n\n* **`list_projects`** : Извлекает список ваших проектов Neon, предоставляя сводку каждого проекта, связанного с вашей учетной записью Neon. Поддерживает ограничение количества возвращаемых проектов (по умолчанию: 10).\n* **`describe_project`** : извлекает подробную информацию о конкретном проекте Neon, включая его идентификатор, название и связанные ветви и базы данных.\n* **`create_project`** : Создает новый проект Neon в вашей учетной записи Neon. Проект действует как контейнер для ветвей, баз данных, ролей и вычислений.\n* **`delete_project`** : Удаляет существующий проект Neon и все связанные с ним ресурсы.\n\n**Управление филиалом:**\n\n* **`create_branch`** : Создает новую ветку в указанном проекте Neon. Использует функцию [ветвления Neon](/docs/introduction/branching) для разработки, тестирования или миграции.\n* **`delete_branch`** : Удаляет существующую ветку из проекта Neon.\n* **`describe_branch`** : Извлекает сведения о конкретной ветви, такие как ее имя, идентификатор и родительскую ветвь.\n* **`list_branch_computes`** : список конечных точек вычислений для проекта или конкретной ветви, включая идентификатор вычислений, тип, размер и информацию об автоматическом масштабировании.\n\n**Выполнение SQL-запроса:**\n\n* **`get_connection_string`** : Возвращает строку подключения к базе данных.\n* **`run_sql`** : Выполняет один SQL-запрос к указанной базе данных Neon. Поддерживает операции чтения и записи.\n* **`run_sql_transaction`** : выполняет серию SQL-запросов в рамках одной транзакции к базе данных Neon.\n* **`get_database_tables`** : выводит список всех таблиц в указанной базе данных Neon.\n* **`describe_table_schema`** : извлекает определение схемы конкретной таблицы, подробно описывая столбцы, типы данных и ограничения.\n* **`list_slow_queries`** : определяет узкие места производительности, находя самые медленные запросы в базе данных. Требуется расширение pg\\_stat\\_statements.\n\n**Миграции базы данных (изменения схемы):**\n\n* **`prepare_database_migration`** : Инициирует процесс миграции базы данных. Что особенно важно, создает временную ветвь для безопасного применения и тестирования миграции перед тем, как затронуть основную ветвь.\n* **`complete_database_migration`** : Завершает и применяет подготовленную миграцию базы данных к основной ветке. Это действие объединяет изменения из временной ветки миграции и очищает временные ресурсы.\n\n**Настройка производительности запроса:**\n\n* **`explain_sql_statement`** : Анализирует SQL-запрос и возвращает подробную информацию о плане выполнения, помогающую понять производительность запроса.\n* **`prepare_query_tuning`** : определяет потенциальные проблемы производительности в SQL-запросе и предлагает оптимизации. Создает временную ветку для тестирования улучшений.\n* **`complete_query_tuning`** : Завершает и применяет оптимизации запросов после тестирования. Объединяет изменения из временной ветки настройки с основной веткой.\n\n**Неоновая аутентификация:**\n\n* **`provision_neon_auth`** : Действие по предоставлению Neon Auth для проекта Neon. Позволяет разработчикам легко настраивать инфраструктуру аутентификации, создавая интеграцию со Stack Auth ( `@stackframe/stack` ).\n\n## Миграции\n\nМиграции — это способ управления изменениями в схеме базы данных с течением времени. С сервером Neon MCP LLM могут безопасно выполнять миграции с помощью отдельных команд «Start» ( `prepare_database_migration` ) и «Commit» ( `complete_database_migration` ).\n\nКоманда \"Start\" принимает миграцию и запускает ее в новой временной ветке. После возврата эта команда намекает LLM, что он должен протестировать миграцию в этой ветке. Затем LLM может запустить команду \"Commit\", чтобы применить миграцию к исходной ветке.\n\n# Разработка\n\n## Разработка с использованием MCP CLI Client\n\nСамый простой способ итерации на сервере MCP — использовать `mcp-client/` . Подробнее см. в `mcp-client/README.md` .\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Разработка с использованием Claude Desktop (локальный сервер MCP)\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\nЗатем **перезапускайте Claude** каждый раз, когда захотите протестировать изменения.\n\n# Тестирование\n\nДля запуска тестов необходимо настроить файл `.env` в соответствии с файлом `.env.example` .\n\n```bash\nnpm run test\n```","Russian","ru-RU",{"_27":72,"_31":76,"_36":77},{"_29":73,"_31":74,"_33":75},"让您可以使用 Claude Desktop 或任何 MCP 客户端，通过自然语言使用[Neon](https://neon.tech/)完成任务。","mcp-服务器-neon","# Neon MCP 服务器\n\n**Neon MCP Server**是一个开源工具，可让您使用**自然语言**与 Neon Postgres 数据库进行交互。\n\n[![npm 版本](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![npm 下载](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon) [![许可证：MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![铁匠徽章](https://smithery.ai/badge/neon)](https://smithery.ai/server/neon)\n\n模型上下文协议 (MCP) 是一种[全新的标准化协议，](https://modelcontextprotocol.io/introduction)旨在管理大型语言模型 (LLM) 与外部系统之间的上下文。本仓库提供了[Neon](https://neon.tech)的安装程序和 MCP 服务器。\n\nNeon 的 MCP 服务器充当自然语言请求和[Neon API](https://api-docs.neon.tech/reference/getting-started-with-neon-api)之间的桥梁。它基于 MCP 构建，将您的请求转换为必要的 API 调用，使您能够无缝地管理创建项目和分支、运行查询以及执行数据库迁移等任务。\n\nNeon MCP 服务器的一些主要功能包括：\n\n* \\*\\*自然语言交互：\\*\\*使用直观的对话命令管理 Neon 数据库。\n* \\*\\*简化的数据库管理：\\*\\*无需编写 SQL 或直接使用 Neon API 即可执行复杂的操作。\n* \\*\\*非开发人员的可访问性：\\*\\*使具有不同技术背景的用户能够与 Neon 数据库进行交互。\n* \\*\\*数据库迁移支持：\\*\\*利用 Neon 的分支功能通过自然语言发起数据库模式更改。\n\n例如，在 Claude Desktop 或任何 MCP 客户端中，您可以使用自然语言通过 Neon 完成以下操作：\n\n* `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.`\n* `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\".`\n* `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> \\[！笔记]\\\n> Neon MCP 服务器通过自然语言请求提供强大的数据库管理功能。**请务必在执行 LLM 请求的操作之前对其进行审核和授权**。确保只有授权用户和应用程序才能访问 Neon MCP 服务器和 Neon API 密钥。\n\n## 设置 Neon MCP 服务器\n\n您可以通过两种方式将 MCP 客户端连接到 Neon：\n\n1. \\*\\*远程 MCP 服务器（预览版）：\\*\\*使用 OAuth 身份验证连接到 Neon 托管的 MCP 服务器。此方法更加便捷，无需管理 API 密钥。此外，您将自动收到最新功能和改进，并立即获得更新。\n\n2. \\*\\*本地 MCP 服务器：\\*\\*在您的机器上本地运行 Neon MCP 服务器，并使用 Neon API 密钥进行身份验证。\n\n## 先决条件\n\n* MCP 客户端应用程序。\n* 一个[Neon 帐户](https://console.neon.tech/signup)。\n* \\*\\*Node.js（>= v18.0.0）和 npm：\\*\\*从[nodejs.org](https://nodejs.org)下载。\n\n要设置本地 MCP 服务器，您还需要一个 Neon API 密钥。请参阅[Neon API 密钥文档](https://neon.tech/docs/manage/api-keys)，了解如何生成密钥。\n\n### 选项 1. 远程托管 MCP 服务器（预览版）\n\n使用 OAuth 连接到 Neon 托管的 MCP 服务器进行身份验证。这是最简单的设置，无需在本地安装此服务器，也不需要在客户端配置 Neon API 密钥。\n\n* 将以下“Neon”条目添加到客户端的 MCP 服务器配置文件（例如`mcp.json` 、 `mcp_config.json` ）：\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/sse\"]\n }\n }\n }\n ```\n\n* 保存配置文件。\n\n* 重新启动或刷新您的 MCP 客户端。\n\n* 您的浏览器中将打开一个 OAuth 窗口。按照提示授权您的 MCP 客户端访问您的 Neon 帐户。\n\n### 选项 2. 本地 MCP 服务器\n\n在本地机器上运行 Neon MCP 服务器。\n\n**通过 Smithery 设置：**\n\n```bash\nnpx -y @smithery/cli@latest install neon --client \n```\n\n系统将提示您输入 Neon API 密钥。请输入您在[先决条件](#prerequisites)部分获取的 API 密钥。将``替换为您的 MCP 客户端应用程序名称。支持的客户端名称包括：\n\n* [克劳德桌面](https://claude.ai/download)`claude`\n* [Cursor](https://cursor.com)的`cursor` （通过`smithery`安装使 MCP 服务器成为 Cursor 中的全局 MCP 服务器）\n* `windsurf`适用于[风帆冲浪编辑器](https://codeium.com/windsurf)\n* `roo-cline`用于[Roo Cline VS Code 扩展](https://github.com/RooVetGit/Roo-Code)\n* [机智](https://witsyai.com/)换`witsy`\n* `enconvo`用于[Enconvo](https://www.enconvo.com/)\n* [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)的`vscode` （预览版）\n\n安装后重新启动 MCP 客户端。\n\n**通过 npm 设置**\n\n如果您的 MCP 客户端未在此处列出，您可以手动将 Neon MCP 服务器详细信息添加到客户端的`mcp_config`文件中。\n\n在客户端的`mcp_config`文件的`mcpServers`部分中添加以下 JSON 配置，将``替换为您的实际 Neon API 密钥：\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### 故障排除\n\n如果您的客户端不使用`JSON`来配置 MCP 服务器（例如旧版本的 Cursor），您可以在出现提示时使用以下命令：\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Windows 上的故障排除\n\n如果您使用的是 Windows，并且在添加 MCP 服务器时遇到问题，则可能需要使用命令提示符 ( `cmd` ) 或适用于 Linux 的 Windows 子系统 ( `wsl` ) 来运行必要的命令。您的配置设置可能类似于以下内容：\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## 指南\n\n* [Neon MCP 服务器指南](https://neon.tech/docs/ai/neon-mcp-server)\n* [将 MCP 客户端连接到 Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n* [带有 Neon MCP 服务器的 Cursor](https://neon.tech/guides/cursor-mcp-neon)\n* [带有 Neon MCP 服务器的 Claude 桌面](https://neon.tech/guides/neon-mcp-server)\n* [Cline 与 Neon MCP 服务器](https://neon.tech/guides/cline-mcp-neon)\n* [使用 Neon MCP 服务器进行风帆冲浪](https://neon.tech/guides/windsurf-mcp-neon)\n* [Zed 与 Neon MCP 服务器](https://neon.tech/guides/zed-mcp-neon)\n\n# 特征\n\n## 支持的工具\n\nNeon MCP 服务器提供以下操作，这些操作作为“工具”提供给 MCP 客户端。您可以使用这些工具通过自然语言命令与您的 Neon 项目和数据库进行交互。\n\n**项目管理：**\n\n* **`list_projects`** ：检索您的 Neon 项目列表，提供与您的 Neon 帐户关联的每个项目的摘要。支持限制返回的项目数量（默认值：10）。\n* **`describe_project`** ：获取有关特定 Neon 项目的详细信息，包括其 ID、名称以及相关分支和数据库。\n* **`create_project`** ：在您的 Neon 帐户中创建一个新的 Neon 项目。项目充当分支、数据库、角色和计算资源的容器。\n* **`delete_project`** ：删除现有的 Neon 项目及其所有相关资源。\n\n**分行管理：**\n\n* **`create_branch`** ：在指定的 Neon 项目中创建一个新的分支。利用[Neon 的分支](/docs/introduction/branching)功能进行开发、测试或迁移。\n* **`delete_branch`** ：从 Neon 项目中删除现有分支。\n* **`describe_branch`** ：检索有关特定分支的详细信息，例如其名称、ID 和父分支。\n* **`list_branch_computes`** ：列出项目或特定分支的计算端点，包括计算 ID、类型、大小和自动缩放信息。\n\n**SQL查询执行：**\n\n* **`get_connection_string`** ：返回数据库连接字符串。\n* **`run_sql`** ：针对指定的 Neon 数据库执行单个 SQL 查询。支持读写操作。\n* **`run_sql_transaction`** ：针对 Neon 数据库在单个事务中执行一系列 SQL 查询。\n* **`get_database_tables`** ：列出指定 Neon 数据库中的所有表。\n* **`describe_table_schema`** ：检索特定表的模式定义，详细说明列、数据类型和约束。\n* **`list_slow_queries`** ：通过查找数据库中最慢的查询来识别性能瓶颈。需要 pg\\_stat\\_statements 扩展。\n\n**数据库迁移（架构更改）：**\n\n* **`prepare_database_migration`** ：启动数据库迁移过程。关键的是，它会创建一个临时分支，以便在迁移影响主分支之前安全地应用和测试迁移。\n* **`complete_database_migration`** ：完成并应用已准备好的数据库迁移到主分支。此操作会合并临时迁移分支中的更改并清理临时资源。\n\n**查询性能调整：**\n\n* **`explain_sql_statement`** ：分析 SQL 查询并返回详细的执行计划信息，以帮助了解查询性能。\n* **`prepare_query_tuning`** ：识别 SQL 查询中潜在的性能问题并提出优化建议。创建一个临时分支来测试改进效果。\n* **`complete_query_tuning`** ：测试后完成并应用查询优化。将临时调整分支中的更改合并到主分支。\n\n**Neon Auth：**\n\n* **`provision_neon_auth`** ：为 Neon 项目配置 Neon Auth 的操作。它允许开发者通过与 Stack Auth ( `@stackframe/stack` ) 集成，轻松设置身份验证基础架构。\n\n## 迁移\n\n迁移是一种管理数据库架构随时间变化的方法。借助 Neon MCP 服务器，LLM 可以使用单独的“启动”( `prepare_database_migration` ) 和“提交”( `complete_database_migration` ) 命令安全地执行迁移。\n\n“Start”命令接受迁移并在新的临时分支中运行它。返回后，此命令会提示LLM应该在此分支上测试迁移。然后，LLM可以运行“Commit”命令将迁移应用到原始分支。\n\n# 发展\n\n## 使用 MCP CLI 客户端进行开发\n\n在 MCP Server 上进行迭代最简单的方法是使用`mcp-client/` 。了解更多信息，请参阅`mcp-client/README.md` 。\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## 使用 Claude Desktop（本地 MCP 服务器）进行开发\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\n然后，每次想要测试更改时**重新启动 Claude** 。\n\n# 测试\n\n要运行测试，您需要根据`.env.example`文件设置`.env`文件。\n\n```bash\nnpm run test\n```","Chinese","zh-CN","githubUser","locale",{"_81":82,"_13":83,"_92":40,"_93":94,"_16":95,"_96":97,"_31":32,"_98":99,"_107":-5,"_108":-5,"_109":110,"_163":164,"_169":-5,"_106":32,"_170":171,"_141":172,"_173":174},"addedAt","2024-12-10T21:15:11.422053Z",[84,85,86,87,88,89,90,91],"author:official","category:databases","category:developer-tools","category:rag-systems","environment:network","hosting:remote-capable","language:typescript","license_grade:a","descriptionMarkdown","descriptionPlainText","Lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things with Neon.",232,"integrations",[],"namespace",{"_100":101,"_106":105},"owner",{"_102":103},"githubAccount",{"_104":105},"login","neondatabase-labs","slug","readmeMarkdown","redditPostExternalId","repository",{"_111":112,"_123":124,"_128":129,"_150":-5,"_151":152,"_153":154,"_158":159},"argumentsJsonSchema",{"_113":114,"_120":121,"_118":122},"properties",{"_115":116},"NEON_API_KEY",{"_29":117,"_118":119},"Neon API key, which can be generated through the Neon console.","type","string","required",[115],"object","githubProject",{"_33":125,"_126":127},"

\n\n# Neon MCP Server\n\n[![Install MCP Server in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=Neon&config=eyJ1cmwiOiJodHRwczovL21jcC5uZW9uLnRlY2gvbWNwIn0%3D)\n\n**Neon MCP Server** is an open-source tool that lets you interact with your Neon Postgres databases in **natural language**.\n\n[![npm version](https://img.shields.io/npm/v/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon)\n[![npm downloads](https://img.shields.io/npm/dt/@neondatabase/mcp-server-neon)](https://www.npmjs.com/package/@neondatabase/mcp-server-neon)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nThe Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) designed to manage context between large language models (LLMs) and external systems. This repository offers an installer and an MCP Server for [Neon](https://neon.tech).\n\nNeon's MCP server acts as a bridge between natural language requests and the [Neon API](https://api-docs.neon.tech/reference/getting-started-with-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.\n\nSome of the key features of the Neon MCP server include:\n\n- **Natural language interaction:** Manage Neon databases using intuitive, conversational commands.\n- **Simplified database management:** Perform complex actions without writing SQL or directly using the Neon API.\n- **Accessibility for non-developers:** Empower users with varying technical backgrounds to interact with Neon databases.\n- **Database migration support:** Leverage Neon's branching capabilities for database schema changes initiated via natural language.\n\nFor example, in Claude Desktop, or any MCP Client, you can use natural language to accomplish things with Neon, such as:\n\n- `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.`\n- `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\".`\n- `Can you give me a summary of all of my Neon projects and what data is in each one?`\n\n> [!WARNING] \n> **Neon MCP Server Security Considerations** \n> 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.\n>\n> 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.\n>\n> For more information, see [MCP security guidance →](https://neon.tech/docs/ai/neon-mcp-server#mcp-security-guidance).\n\n## Setting up Neon MCP Server\n\nYou have two options for connecting your MCP client to Neon:\n\n1. **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.\n\n2. **Local MCP Server:** Run the Neon MCP server locally on your machine, authenticating with a Neon API key.\n\n## Prerequisites\n\n- An MCP Client application.\n- A [Neon account](https://console.neon.tech/signup).\n- **Node.js (>= v18.0.0) and npm:** Download from [nodejs.org](https://nodejs.org).\n\nFor Local MCP Server setup, you also need a Neon API key. See [Neon API Keys documentation](https://neon.tech/docs/manage/api-keys) for instructions on generating one.\n\n### Option 1. Remote Hosted MCP Server (Preview)\n\nConnect 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.\n\n- Add the following \"Neon\" entry to your client's MCP server configuration file (e.g., `mcp.json`, `mcp_config.json`):\n\n ```json\n {\n \"mcpServers\": {\n \"Neon\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"mcp-remote\", \"https://mcp.neon.tech/mcp\"]\n }\n }\n }\n ```\n\n- Save the configuration file.\n- Restart or refresh your MCP client.\n- An OAuth window will open in your browser. Follow the prompts to authorize your MCP client to access your Neon account.\n\n> 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 provide either the `org_id` or the `project_id` in your prompt to MCP client.\n\nRemote MCP Server also supports authentication using API key in the `Authorization` header if your client supports it\n\n```json\n{\n \"mcpServers\": {\n \"Neon\": {\n \"url\": \"https://mcp.neon.tech/mcp\",\n \"headers\": {\n \"Authorization\": \"Bearer <$NEON_API_KEY>\"\n }\n }\n }\n}\n```\n\n> Provider organization's API key to limit access to projects under the organization only.\n\nMCP 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.\n\n### Option 2. Local MCP Server\n\nRun 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.\n\nAdd the following JSON configuration within the `mcpServers` section of your client's `mcp_config` file, replacing `` with your actual Neon API key:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Troubleshooting\n\nIf 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:\n\n```bash\nnpx -y @neondatabase/mcp-server-neon start \n```\n\n#### Troubleshooting on Windows\n\nIf 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:\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"cmd\",\n \"args\": [\n \"/c\",\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n```json\n{\n \"mcpServers\": {\n \"neon\": {\n \"command\": \"wsl\",\n \"args\": [\n \"npx\",\n \"-y\",\n \"@neondatabase/mcp-server-neon\",\n \"start\",\n \"\"\n ]\n }\n }\n}\n```\n\n## Guides\n\n- [Neon MCP Server Guide](https://neon.tech/docs/ai/neon-mcp-server)\n- [Connect MCP Clients to Neon](https://neon.tech/docs/ai/connect-mcp-clients-to-neon)\n- [Cursor with Neon MCP Server](https://neon.tech/guides/cursor-mcp-neon)\n- [Claude Desktop with Neon MCP Server](https://neon.tech/guides/neon-mcp-server)\n- [Cline with Neon MCP Server](https://neon.tech/guides/cline-mcp-neon)\n- [Windsurf with Neon MCP Server](https://neon.tech/guides/windsurf-mcp-neon)\n- [Zed with Neon MCP Server](https://neon.tech/guides/zed-mcp-neon)\n\n# Features\n\n## Supported Tools\n\nThe 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.\n\n**Project Management:**\n\n- **`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.\n- **`list_shared_projects`**: Lists Neon projects shared with the current user. Supports a search parameter and limiting the number of projects returned (default: 10).\n- **`describe_project`**: Fetches detailed information about a specific Neon project, including its ID, name, and associated branches and databases.\n- **`create_project`**: Creates a new Neon project in your Neon account. A project acts as a container for branches, databases, roles, and computes.\n- **`delete_project`**: Deletes an existing Neon project and all its associated resources.\n\n**Branch Management:**\n\n- **`create_branch`**: Creates a new branch within a specified Neon project. Leverages [Neon's branching](/docs/introduction/branching) feature for development, testing, or migrations.\n- **`delete_branch`**: Deletes an existing branch from a Neon project.\n- **`describe_branch`**: Retrieves details about a specific branch, such as its name, ID, and parent branch.\n- **`list_branch_computes`**: Lists compute endpoints for a project or specific branch, including compute ID, type, size, and autoscaling information.\n- **`list_organizations`**: Lists all organizations that the current user has access to. Optionally filter by organization name or ID using the search parameter.\n- **`reset_from_parent`**: Resets the current branch to its parent's state, discarding local changes. Automatically preserves to backup if branch has children, or optionally preserve on request with a custom name.\n\n**SQL Query Execution:**\n\n- **`get_connection_string`**: Returns your database connection string.\n- **`run_sql`**: Executes a single SQL query against a specified Neon database. Supports both read and write operations.\n- **`run_sql_transaction`**: Executes a series of SQL queries within a single transaction against a Neon database.\n- **`get_database_tables`**: Lists all tables within a specified Neon database.\n- **`describe_table_schema`**: Retrieves the schema definition of a specific table, detailing columns, data types, and constraints.\n- **`list_slow_queries`**: Identifies performance bottlenecks by finding the slowest queries in a database. Requires the pg_stat_statements extension.\n\n**Database Migrations (Schema Changes):**\n\n- **`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.\n- **`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.\n\n**Query Performance Optimization:**\n\n- **`explain_sql_statement`**: Provides detailed execution plans for SQL queries to help identify performance bottlenecks.\n- **`prepare_query_tuning`**: Analyzes query performance and suggests optimizations like index creation. Creates a temporary branch for safely testing these optimizations.\n- **`complete_query_tuning`**: Applies or discards query optimizations after testing. Can merge changes from the temporary branch to the main branch.\n- **`list_slow_queries`**: Identifies and analyzes slow-performing queries in your database. Requires the `pg_stat_statements` extension.\n\n**Compute Management:**\n\n- **`list_branch_computes`**: Lists compute endpoints for a project or specific branch, showing details like compute ID, type, size, and last active time.\n\n**Neon Auth:**\n\n- **`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`).\n\n**Query Performance Tuning:**\n\n- **`explain_sql_statement`**: Analyzes a SQL query and returns detailed execution plan information to help understand query performance.\n- **`prepare_query_tuning`**: Identifies potential performance issues in a SQL query and suggests optimizations. Creates a temporary branch for testing improvements.\n- **`complete_query_tuning`**: Finalizes and applies query optimizations after testing. Merges changes from the temporary tuning branch to the main branch.\n\n## Migrations\n\nMigrations 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.\n\nThe \"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.\n\n# Development\n\n## Development with MCP CLI Client\n\nThe easiest way to iterate on the MCP Server is using the `mcp-client/`. Learn more in `mcp-client/README.md`.\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\ncd mcp-client/ && NEON_API_KEY=... npm run start:mcp-server-neon\n```\n\n## Development with Claude Desktop (Local MCP Server)\n\n```bash\nnpm install\nnpm run build\nnpm run watch # You can keep this open.\nnode dist/index.js init $NEON_API_KEY\n```\n\nThen, **restart Claude** each time you want to test changes.\n\n# Testing\n\nTo run the tests you need to setup the `.env` file according to the `.env.example` file.\n\n```bash\nnpm run test\n```\n","url","https://github.com/neondatabase/mcp-server-neon","githubRepository",{"_130":131,"_132":133,"_134":135,"_16":136,"_137":138,"_31":32,"_100":139,"_143":144,"_145":146,"_148":149},"defaultBranch","main","fullName","neondatabase/mcp-server-neon","githubTreeId",268315,181,"language","TypeScript",{"_104":140,"_141":142},"neondatabase","uid","iwpjil2epb","recentStargazers",6,"spdxLicense",{"_31":147},"MIT License","stargazers",482,"glamaJson","inspectable",false,"npmPackage",{"_31":155,"_156":157},"@neondatabase/mcp-server-neon","weeklyDownloads",832,"supportedPlatforms",[160,161,162],"WINDOWS","LINUX","MACOS","scores",{"_165":166,"_167":-5,"_168":-5},"license",100,"quality","security","simpleIcon","toolCount",0,"1yes4hhjq4","updatedAt","2025-10-01T15:25:41.419256Z","meta",[177,180,182,189,192,194,197,200,203,206,209,211,214,217,219,221,223,225,227],{"_178":179},"title","mcp-server-neon | Glama",{"_181":94,"_31":29},"content",{"_183":184,"_185":186,"_187":188},"href","https://glama.ai/mcp/servers/@neondatabase-labs/mcp-server-neon","rel","canonical","tagName","link",{"_181":32,"_190":191},"property","og:title",{"_181":94,"_190":193},"og:description",{"_181":195,"_190":196},"https://glama.ai/logo.png","og:logo",{"_181":198,"_190":199},"https://glama.ai/mcp/servers/@neondatabase-labs/mcp-server-neon/og-image","og:image",{"_181":201,"_190":202},"630","og:image:height",{"_181":204,"_190":205},"1200","og:image:width",{"_181":207,"_190":208},"website","og:type",{"_181":184,"_190":210},"og:url",{"_181":212,"_190":213},"Glama – MCP Hosting Platform","og:site_name",{"_181":215,"_31":216},"summary_large_image","twitter:card",{"_181":212,"_31":218},"twitter:title",{"_181":94,"_31":220},"twitter:description",{"_181":198,"_31":222},"twitter:image",{"_181":201,"_31":224},"twitter:image:height",{"_181":204,"_31":226},"twitter:image:width",{"_228":229},"script:ld+json",{"_230":231,"_232":233},"@context","http://schema.org","@graph",[234],{"_230":235,"_236":237,"_238":239},"https://schema.org","@type","BreadcrumbList","itemListElement",[240,247,251,255],{"_236":241,"_242":243,"_31":244,"_245":246},"ListItem","item","/","Glama","position",1,{"_236":241,"_242":248,"_31":249,"_245":250},"/mcp","MCP",2,{"_236":241,"_242":252,"_31":253,"_245":254},"/mcp/servers","Servers",3,{"_236":241,"_242":256,"_31":32,"_245":257},"/mcp/servers/@neondatabase-labs/mcp-server-neon",4,"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/_explorer/blob/~commit/~/_route",{"_261":262,"_27":268,"_286":287,"_175":301,"_298":325,"_326":327},"blob",{"_181":263,"_264":265,"_266":267},"","fileName","neon.svg","size",2810,{"_81":82,"_13":269,"_92":40,"_93":94,"_16":95,"_96":270,"_31":32,"_98":271,"_107":-5,"_108":-5,"_109":274,"_163":285,"_169":-5,"_106":32,"_170":171,"_141":172,"_173":174},[84,85,86,87,88,89,90,91],[],{"_100":272,"_106":105},{"_102":273},{"_104":105},{"_111":275,"_123":279,"_128":280,"_150":-5,"_151":152,"_153":283,"_158":284},{"_113":276,"_120":278,"_118":122},{"_115":277},{"_29":117,"_118":119},[115],{"_33":125,"_126":127},{"_130":131,"_132":133,"_134":135,"_16":136,"_137":138,"_31":32,"_100":281,"_143":144,"_145":282,"_148":149},{"_104":140,"_141":142},{"_31":147},{"_31":155,"_156":157},[160,161,162],{"_165":166,"_167":-5,"_168":-5},"member",{"_288":289,"_292":293,"_294":295,"_134":296,"_297":152,"_298":265,"_299":300,"_266":267,"_118":261},"commit",{"_290":291},"sha","08380ceffee1aa0d9833b9dbd5b1be75b34274c0","contentStoredObjectPointerId",10025853,"fullPath","landing/icons/neon.svg",268295,"indexable","path","safeToDisplayAsText",true,[302,304,306,308,310,311,312,314,315,316,317,318,319,320,321,322,323,324],{"_178":303},"neon.svg | mcp-server-neon | Glama",{"_181":305,"_31":29},"Enterprise-grade security, privacy, and features like agents, MCP, prompt templates, and more.",{"_183":307,"_185":186,"_187":188},"https://glama.ai/mcp/servers/@neondatabase-labs/mcp-server-neon/blob/08380ceffee1aa0d9833b9dbd5b1be75b34274c0/landing/icons",{"_181":309,"_190":191},"neon.svg | mcp-server-neon",{"_181":305,"_190":193},{"_181":195,"_190":196},{"_181":313,"_190":199},"https://glama.ai/generated-images/og?title=neon.svg+%7C+mcp-server-neon",{"_181":201,"_190":202},{"_181":204,"_190":205},{"_181":207,"_190":208},{"_181":307,"_190":210},{"_181":212,"_190":213},{"_181":215,"_31":216},{"_181":212,"_31":218},{"_181":305,"_31":220},{"_181":313,"_31":222},{"_181":201,"_31":224},{"_181":204,"_31":226},"landing/icons","treeMembers",[328,332],{"_288":329,"_294":330,"_298":331,"_118":261},{"_290":291},"landing/icons/github.svg","github.svg",{"_288":333,"_294":295,"_298":265,"_118":261},{"_290":291},"actionData","errors"]

MCP directory API