AWS Labs Aurora DSQL-MCP-Server - Amazon Aurora DSQL

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS Labs Aurora DSQL-MCP-Server

Ein MCP-Server (Model Context Protocol) von AWS Labs für Aurora DSQL

Features

  • Konvertierung von menschenlesbaren Fragen und Befehlen in strukturierte Postgres-kompatible SQL-Abfragen und deren Ausführung anhand der konfigurierten Aurora DSQL-Datenbank.

  • Standardmäßig schreibgeschützt, Transaktionen aktiviert mit --allow-writes

  • Wiederverwendung von Verbindungen zwischen Anfragen zur Verbesserung der Leistung

  • Integrierter Zugriff auf Aurora DSQL-Dokumentation, Suche und Best-Practice-Empfehlungen

Verfügbare Tools

Datenbankoperationen

  • readonly_query — Führt schreibgeschützte SQL-Abfragen für Ihren DSQL-Cluster aus

  • transact — Führt Schreiboperationen in einer Transaktion aus (erfordert) --allow-writes

  • get_schema — Ruft Informationen zum Tabellenschema ab

Dokumentation und Empfehlungen

  • dsql_search_documentation — Durchsucht die Aurora DSQL-Dokumentation

    • Parameter: search_phrase (erforderlich), (optional) limit

  • dsql_read_documentation — Liest spezifische DSQL-Dokumentationsseiten

    • Parameter: url (erforderlich), (optional), start_index (optional) max_length

  • dsql_recommend — Holen Sie sich Empfehlungen für bewährte DSQL-Praktiken

    • Parameter: (erforderlich) url

Voraussetzungen

  1. Ein AWS-Konto mit einem Aurora DSQL-Cluster

  2. Dieser MCP-Server kann nur lokal auf demselben Host wie Ihr LLM-Client ausgeführt werden.

  3. AWS-Anmeldeinformationen mit Zugriff auf AWS-Services einrichten

    • Sie benötigen ein AWS-Konto mit einer Rolle mit diesen Berechtigungen:

      • dsql:DbConnectAdmin- Stellen Sie als Admin-Benutzer eine Verbindung zu DSQL-Clustern her

      • dsql:DbConnect- Connect zu DSQL-Clustern mit benutzerdefinierten Datenbankrollen her (nur erforderlich, wenn Sie Benutzer ohne Administratorrechte verwenden)

    • AWS-Anmeldeinformationen mit aws configure oder Umgebungsvariablen konfigurieren

Installation

Für die meisten Tools sollte es ausreichend sein, die Konfiguration anhand der Anweisungen zur Standardinstallation zu aktualisieren.

Für Claude Code und Codex werden separate Anweisungen beschrieben.

Standardinstallation: Aktualisierung der entsprechenden MCP-Konfigurationsdatei

Verwenden von uv

  1. Installieren Sie es uv von Astral oder der GitHub README-Datei

  2. Installieren Sie Python mit uv python install 3.10

Konfigurieren Sie den MCP-Server in Ihrer MCP-Client-Konfiguration (Suchen der MCP-Konfigurationsdatei)

{ "mcpServers": { "awslabs.aurora-dsql-mcp-server": { "command": "uvx", "args": [ "awslabs.aurora-dsql-mcp-server@latest", "--cluster_endpoint", "[your dsql cluster endpoint, e.g. abcdefghijklmnopqrst234567.dsql.us-east-1.on.aws]", "--region", "[your dsql cluster region, e.g. us-east-1]", "--database_user", "[your dsql username, e.g. admin]", "--profile", "default" ], "env": { "FASTMCP_LOG_LEVEL": "ERROR" }, "disabled": false, "autoApprove": [] } } }

Installation von Windows

Für Windows-Benutzer unterscheidet sich das MCP-Serverkonfigurationsformat geringfügig:

{ "mcpServers": { "awslabs.aurora-dsql-mcp-server": { "disabled": false, "timeout": 60, "type": "stdio", "command": "uv", "args": [ "tool", "run", "--from", "awslabs.aurora-dsql-mcp-server@latest", "awslabs.aurora-dsql-mcp-server.exe" ], "env": { "FASTMCP_LOG_LEVEL": "ERROR", "AWS_PROFILE": "your-aws-profile", "AWS_REGION": "us-east-1" } } } }

Die MCP-Client-Konfigurationsdatei finden

Für einige der gängigsten Agentic-Entwicklungstools finden Sie Ihre MCP-Client-Konfigurationen unter den folgenden Dateipfaden:

  • Kiro:

    • Benutzerkonfiguration: ~/.kiro/settings/mcp.json

    • Workspace-Konfiguration: /path/to/workspace/.kiro/settings/mcp.json

  • Claude Code: Ausführliche Hilfe zur Einrichtung finden Sie unter Claude Code Installation

    • Benutzerkonfiguration: ~/.claude.json in "mcpServers"

    • Projektkonfiguration: /path/to/project/.mcp.json

    • Lokale Config: ~/.claude.json in "projects" -> "path/to/project" -> "mcpServers"

  • Cursor:

    • Global: ~/.cursor/mcp.json

    • Projekt: /path/to/project/.cursor/mcp.json

  • Kodex: ~/.codex/config.toml

  • Warp:

    • Bearbeitung von Dateien: ~/.warp/mcp_settings.json

    • Anwendungseditor: Settings > AI > Manage MCP Servers und fügen Sie JSON ein

  • Amazon Q Entwickler-CLI: ~/.aws/amazonq/mcp.json

  • Cline: Normalerweise ein verschachtelter VS-Codepfad - ~/.vscode-server/path/to/cline_mcp_settings.json

Claude Code

Voraussetzungen

Wichtig: Die MCP-Serververwaltung ist nur über das Claude Code CLI-Terminal-Erlebnis verfügbar, nicht über den systemeigenen Panel-Modus von VS Code.

Installieren Sie zuerst die Claude Code CLI, indem Sie dem von Claude empfohlenen systemeigenen Installationsprozess folgen.

Auswahl des richtigen Bereichs

Claude Code bietet 3 verschiedene Gültigkeitsbereiche: lokal (Standard), Projekt und Benutzer. Außerdem gibt er an, welcher Bereich je nach Vertraulichkeit der Zugangsdaten ausgewählt und geteilt werden muss. Weitere Informationen finden Sie in der Claude Code-Dokumentation zu MCP-Installationsbereichen.

  1. Server mit lokalem Geltungsbereich stellen die Standardkonfigurationsebene dar und werden unter dem Pfad Ihres Projekts gespeichert. ~/.claude.json Sie sind beide für Sie privat und nur innerhalb des aktuellen Projektverzeichnisses zugänglich. Dies ist die Standardeinstellung scope beim Erstellen von MCP-Servern.

  2. Projektbezogene Server ermöglichen die Zusammenarbeit im Team und sind dennoch nur in einem Projektverzeichnis zugänglich. Server mit Projektbereich fügen eine .mcp.json Datei im Stammverzeichnis Ihres Projekts hinzu. Diese Datei ist so konzipiert, dass sie in die Versionskontrolle eingecheckt werden kann, um sicherzustellen, dass alle Teammitglieder Zugriff auf dieselben MCP-Tools und -Dienste haben. Wenn Sie einen projektbezogenen Server hinzufügen, erstellt oder aktualisiert Claude Code diese Datei automatisch mit der entsprechenden Konfigurationsstruktur.

  3. Server mit Benutzerzugriff werden gespeichert ~/.claude.json und bieten projektübergreifenden Zugriff, sodass sie für alle Projekte auf Ihrem Computer verfügbar sind und gleichzeitig für Ihr Benutzerkonto privat bleiben.

Verwenden der Claude-CLI (empfohlen)

Die Verwendung einer interaktiven claude CLI-Sitzung ermöglicht eine verbesserte Problembehebung, daher ist dies der empfohlene Weg.

claude mcp add amazon-aurora-dsql \ --scope [one of local, project, or user] \ --env FASTMCP_LOG_LEVEL="ERROR" \ -- uvx "awslabs.aurora-dsql-mcp-server@latest" \ --cluster_endpoint "[dsql-cluster-id].dsql.[region].on.aws" \ --region "[dsql cluster region, eg. us-east-1]" \ --database_user "[your-username]"
Fehlerbehebung: Claude Code mit Bedrock auf einem anderen AWS-Konto verwenden

Wenn Sie Claude Code mit einem Bedrock AWS-Konto oder -Profil konfiguriert haben, das sich von dem Profil unterscheidet, das für die Verbindung mit Ihrem DSQL-Cluster benötigt wird, müssen Sie zusätzliche Umgebungsargumente angeben:

--env AWS_PROFILE="[dsql profile, eg. default]" \ --env AWS_REGION="[dsql cluster region, eg. us-east-1]" \

Direkte Änderung in der Konfigurationsdatei

Claude Code Erfordert eine alphanumerische Benennung, daher empfehlen wir, Ihren Server zu benennen:aurora-dsql-mcp-server.

Lokaler Geltungsbereich

Update ~/.claude.json im mcpServers projektspezifischen Bereich:

{ "projects": { "/path/to/project": { "mcpServers": {} } } }
Umfang des Projekts

Update /path/to/project/root/.mcp.json im Bereich: mcpServers

{ "mcpServers": {} }
Nutzer-Geltungsbereich

Aktualisierung ~/.claude.json innerhalb des projektspezifischen mcpServers Feldes:

{ "mcpServers": {} }

Kodex

Option 1: Codex CLI

Wenn Sie die Codex CLI installiert haben, können Sie den Befehl codex mcp verwenden, um Ihre MCP-Server zu konfigurieren.

codex mcp add amazon-aurora-dsql \ --env FASTMCP_LOG_LEVEL="ERROR" \ -- uvx "awslabs.aurora-dsql-mcp-server@latest" \ --cluster_endpoint "[dsql-cluster-id].dsql.[region].on.aws" \ --region "[dsql cluster region, eg. us-east-1]" \ --database_user "[your-username]"

Option 2: config.toml

Für eine genauere Steuerung der MCP-Serveroptionen können Sie die Konfigurationsdatei manuell bearbeiten. ~/.codex/config.toml Jeder MCP-Server ist mit einer [mcp_servers.<server-name>] Tabelle in der Konfigurationsdatei konfiguriert.

[mcp_servers.amazon-aurora-dsql] command = "uvx" args = [ "awslabs.aurora-dsql-mcp-server@latest", "--cluster_endpoint", "<DSQL_CLUSTER_ID>.dsql.<AWS_REGION>.on.aws", "--region", "<AWS_REGION>", "--database_user", "<DATABASE_USERNAME>" ] [mcp_servers.amazon-aurora-dsql.env] FASTMCP_LOG_LEVEL = "ERROR"

Installation wird überprüft

Für Amazon Q Developer CLI, Kiro CLI, ClaudeCLI/TUI, or Codex CLI/TUI, ausführen, /mcp um den Status des MCP-Servers zu sehen.

Für die Kiro IDE können Sie auch zur MCP SERVERS Registerkarte des Kiro Panels navigieren, auf der alle konfigurierten MCP-Server und ihre Verbindungsstatusanzeigen angezeigt werden.

Optionen für die Serverkonfiguration

--allow-writes

Standardmäßig erlaubt der DSQL-MCP-Server keine Schreiboperationen („Nur-Lese-Modus“). Alle Aufrufe des Transact-Tools schlagen in diesem Modus fehl. Um das Transact-Tool zu verwenden, lassen Sie Schreibvorgänge zu, indem Sie den Parameter übergeben. --allow-writes

Wir empfehlen, bei der Verbindung zu DSQL den Zugriff mit den geringsten Rechten zu verwenden. Beispielsweise sollten Benutzer nach Möglichkeit eine Rolle verwenden, die schreibgeschützt ist. Im Modus „Nur lesen“ wird nach bestem Wissen und Gewissen auf der Clientseite versucht, Mutationen zurückzuweisen.

--cluster_endpoint

Dies ist ein obligatorischer Parameter, um den Cluster anzugeben, zu dem eine Verbindung hergestellt werden soll. Dies sollte der vollständige Endpunkt Ihres Clusters sein, z. B. 01abc2ldefg3hijklmnopqurstu.dsql.us-east-1.on.aws

--database_user

Dies ist ein obligatorischer Parameter, um den Benutzer anzugeben, als der eine Verbindung hergestellt werden soll. Zum Beispiel admin oder my_user. Beachten Sie, dass die AWS-Anmeldeinformationen, die Sie verwenden, über die Berechtigung verfügen müssen, sich als dieser Benutzer anzumelden. Weitere Informationen zum Einrichten und Verwenden von Datenbankrollen in DSQL finden Sie unter Datenbankrollen mit IAM-Rollen verwenden.

--profile

Sie können das AWS-Profil angeben, das für Ihre Anmeldeinformationen verwendet werden soll. Beachten Sie, dass dies für die Docker-Installation nicht unterstützt wird.

Die Verwendung der AWS_PROFILE Umgebungsvariablen in Ihrer MCP-Konfiguration wird ebenfalls unterstützt:

"env": { "AWS_PROFILE": "your-aws-profile" }

Wenn keines angegeben ist, verwendet der MCP-Server standardmäßig das „Standard“ -Profil in Ihrer AWS-Konfigurationsdatei.

--region

Dies ist ein obligatorischer Parameter, um die Region Ihrer DSQL-Datenbank anzugeben.

--knowledge-server

Optionaler Parameter zur Angabe des Remote-MCP-Serverendpunkts für DSQL-Wissenstools (Suchen, Lesen und Empfehlungen in der Dokumentation). Standardmäßig ist er vorkonfiguriert.

Beispiel:

--knowledge-server https://custom-knowledge-server.example.com

Hinweis: Verwenden Sie aus Sicherheitsgründen nur vertrauenswürdige Knowledge Server-Endpunkte. Der Server sollte ein HTTPS-Endpunkt sein.

--knowledge-timeout

Optionaler Parameter zur Angabe des Timeouts in Sekunden für Anfragen an den Knowledge Server.

Standard: 30.0

Beispiel:

--knowledge-timeout 60.0

Erhöhen Sie diesen Wert, wenn beim Zugriff auf Dokumentation in langsamen Netzwerken Timeouts auftreten.