mcp-server-neon

Neon MCP Server

Neon MCP Server ist ein Open-Source-Tool, mit dem Sie in natürlicher Sprache mit Ihren Neon-Postgres-Datenbanken interagieren können.

Das Model Context Protocol (MCP) ist ein neues, standardisiertes Protokoll zur Verwaltung des Kontexts zwischen großen Sprachmodellen (LLMs) und externen Systemen. Dieses Repository bietet ein Installationsprogramm und einen MCP-Server für Neon .

Der MCP-Server von Neon fungiert als Brücke zwischen natürlichsprachlichen Anfragen und der 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.

Zu den wichtigsten Funktionen des Neon MCP-Servers gehören:

• Interaktion in natürlicher Sprache: Verwalten Sie Neon-Datenbanken mit intuitiven, umgangssprachlichen Befehlen.
• Vereinfachte Datenbankverwaltung: Führen Sie komplexe Aktionen aus, ohne SQL zu schreiben oder die Neon-API direkt zu verwenden.
• Zugänglichkeit für Nicht-Entwickler: Ermöglichen Sie Benutzern mit unterschiedlichem technischen Hintergrund die Interaktion mit Neon-Datenbanken.
• Unterstützung bei der Datenbankmigration: Nutzen Sie die Verzweigungsfunktionen von Neon für Datenbankschemaänderungen, die über natürliche Sprache initiiert werden.

Beispielsweise können Sie in Claude Desktop oder einem beliebigen MCP-Client mithilfe natürlicher Sprache Dinge mit Neon erreichen, wie etwa:

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

[!NOTIZ]
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.

Einrichten des Neon MCP-Servers

Sie haben zwei Möglichkeiten, Ihren MCP-Client mit Neon zu verbinden:

1. 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.
2. 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.

Voraussetzungen

• Eine MCP-Clientanwendung.
• Ein Neon-Konto .
• Node.js (>= v18.0.0) und npm: Download von nodejs.org .

Fü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 .

Option 1. Remote gehosteter MCP-Server (Vorschau)

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

• Fügen Sie der MCP-Serverkonfigurationsdatei Ihres Clients (z. B. mcp.json , mcp_config.json ) den folgenden „Neon“-Eintrag hinzu:
  { "mcpServers": { "Neon": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.neon.tech/sse"] } } }
• Speichern Sie die Konfigurationsdatei.
• Starten Sie Ihren MCP-Client neu oder aktualisieren Sie ihn.
• In Ihrem Browser öffnet sich ein OAuth-Fenster. Folgen Sie den Anweisungen, um Ihrem MCP-Client den Zugriff auf Ihr Neon-Konto zu gestatten.

Option 2. Lokaler MCP-Server

Führen Sie den Neon MCP-Server auf Ihrem lokalen Computer aus.

Einrichtung über Smithery:

Sie werden aufgefordert, Ihren Neon-API-Schlüssel einzugeben. Geben Sie den API-Schlüssel ein, den Sie im Abschnitt „Voraussetzungen“ erhalten haben. Ersetzen Sie <client_name> durch den Namen Ihrer MCP-Client-Anwendung. Unterstützte Client-Namen sind:

• claude für Claude Desktop
• cursor für Cursor (Die Installation über smithery macht den MCP-Server zu einem globalen MCP-Server in Cursor)
• windsurf für Windsurf Editor
• roo-cline für Roo Cline VS Code-Erweiterung
• witsy für Witsy
• enconvo für Enconvo
• vscode für Visual Studio Code (Vorschau)

Starten Sie Ihren MCP-Client nach der Installation neu.

Einrichtung über npm

Wenn Ihr MCP-Client hier nicht aufgeführt ist, können Sie die Neon MCP-Serverdetails manuell zur mcp_config Datei Ihres Clients hinzufügen.

Fügen Sie die folgende JSON-Konfiguration im Abschnitt mcpServers der mcp_config Datei Ihres Clients hinzu und ersetzen Sie <YOUR_NEON_API_KEY> durch Ihren tatsächlichen Neon-API-Schlüssel:

Fehlerbehebung

Wenn 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:

Fehlerbehebung unter Windows

Wenn 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:

Anleitungen

• Neon MCP-Serverhandbuch
• Verbinden Sie MCP-Clients mit Neon
• Cursor mit Neon MCP Server
• Claude Desktop mit Neon MCP Server
• Cline mit Neon MCP Server
• Windsurfen mit Neon MCP Server
• Zed mit Neon MCP Server

Merkmale

Unterstützte Tools

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

Projektmanagement:

• 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).
• describe_project : Ruft detaillierte Informationen zu einem bestimmten Neon-Projekt ab, einschließlich seiner ID, seines Namens und der zugehörigen Zweige und Datenbanken.
• create_project : Erstellt ein neues Neon-Projekt in Ihrem Neon-Konto. Ein Projekt dient als Container für Zweige, Datenbanken, Rollen und Berechnungen.
• delete_project : Löscht ein vorhandenes Neon-Projekt und alle zugehörigen Ressourcen.

Filialleitung:

• create_branch : Erstellt einen neuen Zweig innerhalb eines angegebenen Neon-Projekts. Nutzt die Branching-Funktion von Neon für Entwicklung, Tests oder Migrationen.
• delete_branch : Löscht einen vorhandenen Zweig aus einem Neon-Projekt.
• describe_branch : Ruft Details zu einem bestimmten Zweig ab, z. B. Name, ID und übergeordneter Zweig.
• 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.

Ausführung der SQL-Abfrage:

• get_connection_string : Gibt Ihre Datenbankverbindungszeichenfolge zurück.
• run_sql : Führt eine einzelne SQL-Abfrage für eine angegebene Neon-Datenbank aus. Unterstützt sowohl Lese- als auch Schreibvorgänge.
• run_sql_transaction : Führt eine Reihe von SQL-Abfragen innerhalb einer einzigen Transaktion für eine Neon-Datenbank aus.
• get_database_tables : Listet alle Tabellen innerhalb einer angegebenen Neon-Datenbank auf.
• describe_table_schema : Ruft die Schemadefinition einer bestimmten Tabelle ab und gibt Einzelheiten zu Spalten, Datentypen und Einschränkungen an.
• list_slow_queries : Identifiziert Leistungsengpässe, indem die langsamsten Abfragen in einer Datenbank ermittelt werden. Erfordert die Erweiterung pg_stat_statements.

Datenbankmigrationen (Schemaänderungen):

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

Optimierung der Abfrageleistung:

• explain_sql_statement : Analysiert eine SQL-Abfrage und gibt detaillierte Informationen zum Ausführungsplan zurück, um die Abfrageleistung besser zu verstehen.
• prepare_query_tuning : Identifiziert potenzielle Leistungsprobleme in einer SQL-Abfrage und schlägt Optimierungen vor. Erstellt einen temporären Zweig zum Testen von Verbesserungen.
• complete_query_tuning : Finalisiert und wendet Abfrageoptimierungen nach dem Test an. Führt Änderungen vom temporären Tuning-Zweig in den Hauptzweig ein.

Neon-Auth:

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

Migrationen

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

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

Entwicklung

Entwicklung mit MCP CLI-Client

Die einfachste Möglichkeit, auf dem MCP-Server zu iterieren, ist die Verwendung von mcp-client/ . Weitere Informationen finden Sie in mcp-client/README.md .

Entwicklung mit Claude Desktop (Lokaler MCP-Server)

Starten Sie Claude dann jedes Mal neu, wenn Sie Änderungen testen möchten.

Testen

Um die Tests auszuführen, müssen Sie die .env Datei entsprechend der .env.example -Datei einrichten.