hs-sql-agent
2.0.2
Dokumentation 2.0.2
Dokumentationsversion
2.0.2
2.0.2 Unterstützt 2.0.3 Aktuell
Dokumentation Erste Schritte

Schnellstart

Wählen Sie einen Installationsweg, starten Sie hs-sql-agent und verbinden Sie Ihren ersten MCP-Client.

~5 Min.
EmpfohlenDocker Compose Den vollständigen selbst gehosteten Dienst mit der Compose-Konfiguration des Repositorys starten.
~10 Min.
ASP.NET Core / NuGet Die MCP-Laufzeit und optional die Administrationsoberfläche in eine vorhandene ASP.NET-Core-Anwendung einbetten.
nach Installation
MCP-Client verbinden Einen Schlüssel mit begrenztem Umfang erstellen und Claude Desktop, Cursor oder einen anderen Streamable-HTTP-Client verbinden.

Docker Compose

  1. Umgebungsdatei erstellen

    Kopieren Sie das eingecheckte Beispiel, damit die Konfiguration explizit und überprüfbar bleibt.

    cp .env.example .env
  2. Signaturgeheimnisse ersetzen

    Setzen Sie HMAC_KEY und JWT_KEY auf zwei unterschiedliche, eindeutige Geheimnisse mit jeweils mindestens 32 Byte.

    Die Werte in .env.example sind Platzhalter. Verwenden Sie sie nicht unverändert in einer Bereitstellung.

  3. Dienst starten

    Starten Sie den standardmäßigen Einzelinstanz-Stack.

    docker compose up -d
  4. Administrationsoberfläche öffnen

    Die Anwendung lauscht standardmäßig auf Port 8080.

    Öffnen Sie für eine lokale Installation http://localhost:8080 und schließen Sie die Einrichtung des ersten Administrators ab.

Ersten MCP-Schlüssel erstellen

  1. Runtime → MCP Keys öffnen

    Schlüssel bilden die Identitäts- und Autorisierungsgrenze für MCP.

  2. Datenbank und Werkzeugumfang wählen

    Binden Sie den Schlüssel an einen Database-Management-Eintrag und geben Sie nur die Werkzeuge frei, die der Client benötigt.

  3. Klartextschlüssel kopieren

    Der Lebenszyklusdialog zeigt das neu erstellte Geheimnis einmal zum Kopieren an; speichern Sie es im Secretspeicher des Clients.

  4. Generierte Clientkonfiguration verwenden

    Alternativ senden Sie das Geheimnis als X-MCP-Server-Key an den Streamable-HTTP-Endpunkt.

Der standardmäßige MCP-Endpunkt ist /mcp. Für Clients außerhalb des lokalen Rechners setzen Sie MCP_PUBLIC_ENDPOINT auf die extern erreichbare absolute HTTP- oder HTTPS-URL einschließlich /mcp.

Nächste Schritte

MCP-Client verbinden Header, Streamable-HTTP-Konfiguration, Regeln für den öffentlichen Endpunkt und DML-Elicitation-Kompatibilität.
SQL-Ausführungsmodell Die Grenze Parsing → Validierung → Fähigkeitsnachweis → Kompilierung verstehen, bevor SQL für einen Agenten freigegeben wird.
Datenbankverwaltung Datenbankverbindungen anlegen, Konnektivität testen und verstehen, wie MCP-Schlüssel an Datenbanken gebunden werden.
Produktionskonfiguration Identität, Ratenbegrenzung, Aufbewahrung, verteilten Zustand, Telemetrie und Geheimnisse prüfen.