SQLPad MCP Server

Ein MCP-Server für SQLPad. Richten Sie einen KI-Agenten mit der Basis-URL und einem Service-Token auf eine SQLPad-Instanz aus, und der Agent kann Verbindungen entdecken, Schemata untersuchen, SQL ausführen und gespeicherte Abfragen verwalten.

Anforderungen

• Node.js 20 oder höher.

• Eine erreichbare SQLPad-Instanz.

• Der SQLPad-Server muss SQLPAD_SERVICE_TOKEN_SECRET konfiguriert haben. Ohne diese Konfiguration gibt jede Bearer-authentifizierte Anfrage 401 Unauthorized zurück.

• Ein Service-Token, der in der SQLPad-Admin-GUI generiert wurde.

Related MCP server: SQLite Database MCP Server

Schnellstart

Kein Installationsschritt erforderlich – führen Sie es direkt über npm aus:

SQLPAD_SERVICE_TOKEN=... npx sqlpad-mcp --base-url https://sqlpad.example.com

Oder installieren Sie es global:

npm install -g sqlpad-mcp

Der Server spricht MCP über stdio und wird daher normalerweise von einem MCP-Client gestartet und nicht von Hand. Die direkte Ausführung ist dennoch nützlich, um Anmeldeinformationen zu überprüfen: Bei Erfolg protokolliert er die erkannte SQLPad-Version auf stderr.

Konfiguration

Ein CLI-Flag hat Vorrang vor der entsprechenden Umgebungsvariable. Das Batch-Abfrageintervall (250 ms) ist intern und nicht konfigurierbar.

Claude Code Konfiguration

Fügen Sie den Server zu Ihrer Claude Code mcp.json hinzu:

{
  "mcpServers": {
    "sqlpad": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "sqlpad-mcp",
        "--base-url",
        "https://sqlpad.example.com"
      ],
      "env": {
        "SQLPAD_SERVICE_TOKEN": "..."
      }
    }
  }
}

Die Bereitstellung des Tokens über env hält es aus der Prozessargumentliste heraus, die über ps für alle lesbar ist.

Um die gesperrten Werkzeuggruppen zu aktivieren, fügen Sie "SQLPAD_ALLOW_WRITES": "true" oder "SQLPAD_ALLOW_ADMIN": "true" zum selben env-Block hinzu.

Werkzeuge

Zwölf Werkzeuge sind immer registriert. Sechs weitere sind hinter den beiden SQLPAD_ALLOW_*-Flags gesperrt und standardmäßig deaktiviert.

Ausführung

Entdeckung

Gespeicherte Abfragen

Schreibvorgänge für gespeicherte Abfragen – erfordert SQLPAD_ALLOW_WRITES=true

Admin – erfordert SQLPAD_ALLOW_ADMIN=true

Diese rufen SQLPad-Endpunkte auf, die selbst ein Admin-Service-Token erfordern.

So funktioniert die SQL-Ausführung

SQLPad führt SQL über asynchrone Batches aus. Das Erstellen eines Batches gibt sofort zurück; jede Anweisung wechselt von queued zu started und dann zu finished oder error. Ergebnisse werden für jede Anweisung separat abgerufen und sind erst verfügbar, wenn die Anweisung abgeschlossen ist.

Das run_sql-Werkzeug übernimmt das gesamte Protokoll – erstellen, abfragen, abrufen und Zeilen zurückgeben – sodass ein Agent nur einen Aufruf tätigt. Wenn die Abfrage das konfigurierte Timeout erreicht, gibt das Werkzeug eine batchId zurück, mit der der Agent fortfahren kann, anstatt zu hängen.

Verbindungen haben möglicherweise keine Standarddatenbank. Qualifizieren Sie Tabellennamen als schema.table und verwenden Sie get_connection_schema, um verfügbare Schemata zu entdecken.

Sicherheit

• run_sql führt beliebiges SQL aus, einschließlich DDL und DML, und ist nicht sandboxed. SQLPAD_ALLOW_WRITES beschränkt nur die Mutation der eigenen gespeicherten Abfrageobjekte von SQLPad; es schränkt den SQL-Inhalt nicht ein. Verwenden Sie schreibgeschützte Datenbankanmeldeinformationen für die SQLPad-Verbindung selbst. Das ist die einzige echte Durchsetzung.

• Die /api/service-tokens-Endpunkte von SQLPad sind bewusst nicht exponiert. Ein Werkzeug, das Anmeldeinformationen erstellt, ist ein Privilegieneskalations-Primitiv.

• Admin-Werkzeuge sind standardmäßig deaktiviert.

• Das Service-Token wird aus allen Fehlern und Protokollen entfernt. Die gesamte Protokollierung erfolgt über stderr, da stdout der JSON-RPC-Kanal ist.

• Batches sind auf den eigenen Benutzer des Tokens beschränkt, sodass der Server nur seinen eigenen Abfrageverlauf sieht.

Mitwirken

Klonen Sie das Repository und installieren Sie die Abhängigkeiten:

git clone https://github.com/VAIBHAV7500/sqlpad-mcp.git
cd sqlpad-mcp
npm install
npm run build

Erstellen Sie einen Branch für Ihre Änderung. Bevor Sie einen Pull-Request öffnen, führen Sie Folgendes aus:

npm run typecheck && npm run lint && npm test

CI führt dieselben drei Befehle auf Node 20 und 22 aus.

Lizenz

MIT