Dokumentation

Erste Schritte

Einführung

Was hs-sql-agent ist, wo es zwischen MCP-Clients und Datenbanken sitzt und wie die Sicherheitsgrenze funktioniert.

Schnellstart

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

MCP

MCP-Client verbinden

MCP-Schlüssel erstellen, die generierte Clientkonfiguration kopieren und Elicitation prüfen, bevor DML aktiviert wird.

MCP Tools Reference

Formale Verträge der integrierten MCP-Tools in hs-sql-agent 2.0.2 mit Parametern, Antworten, Autorisierung und Risikogrenzen.

SQL-Compiler

SQL-Ausführungsmodell

Wie hs-sql-agent nicht vertrauenswürdiges SQL vor der Ausführung in validierte, datenbankspezifische Anweisungen überführt.

Safe DML

Auswirkungen vorab prüfen, die Freigabe binden, die Zielzeilen erneut prüfen und nur die exakt freigegebene Änderung per Commit übernehmen.

Datenbankdialekte

Die sechs Datenbanken hinter der gemeinsamen MCP-Schnittstelle und was ein bewusst begrenzter Dialektumfang bedeutet.

SQL-Support-Referenz

Lesbare Zusammenfassung der SQL-Grammatik und Provider-Capabilities von hs-sql-agent 2.0.2.

Administration

Überblick über die Administrationsoberfläche

Die Steuerungsebene für Datenbankzugriff, MCP-Zugangsdaten, Identität, Autorisierung, Audit, Sicherheitsrichtlinien und Runtime-Betrieb.

Datenbankverwaltung

Datenbankverbindungen konfigurieren und betreiben, die über hs-sql-agent 2.0.2 bereitgestellt werden.

MCP-Schlüssel

MCP-Zugangsdaten in hs-sql-agent 2.0.2 ausstellen, einschränken, rotieren, duplizieren und widerrufen.

Custom Tools

Zweckgebundene Query- oder DML-MCP-Tools erstellen und veröffentlichen, ohne die Richtliniengrenzen von hs-sql-agent zu umgehen.

Semantische Metadaten

Datenbank-Ermittlung in hs-sql-agent 2.0.2 um Bedeutungen von Tabellen und Spalten, Beziehungen und Metrik-Metadaten ergänzen.

Mitglieder und Rollen

Admin-Benutzer, Sitzungen, Rollenzuweisungen und den Rollenlebenszyklus in hs-sql-agent 2.0.2 verwalten.

Berechtigungen

Das Path-and-Action-Autorisierungsmodell für Admin-Operationen in hs-sql-agent 2.0.2 verstehen.

Audit

Audit-Datensätze von hs-sql-agent über die Admin-Steuerungsebene abfragen, zusammenfassen, exportieren und aufbewahren.

Sicherheitsrichtlinien

SQL-, DML-, Rate-Limit- und Parallelitätsregeln der hs-sql-agent-2.0.2-Laufzeit über die Admin-Steuerung konfigurieren.

Betriebszustand

Laufzeitmetriken, Datenbankzustand, MCP-Schlüsselnutzung und ausgehende Zustellungen in hs-sql-agent 2.0.2 untersuchen.

Integration

ASP.NET-Core-Integration

HsSqlAgent.Server-Capabilities in eine bestehende ASP.NET-Core-Anwendung integrieren – mit Host-eigener Authentifizierung oder optionaler integrierter Admin-Oberfläche.

Betrieb

Konfigurationsreferenz

Quellcodegestützte Referenz für Umgebungsvariablen und Laufzeitkonfiguration von hs-sql-agent 2.0.2.

Observability und Audit-Betrieb

Health Probes, Slow-Query-Schwellen, Prometheus, OTLP, Audit-Aufbewahrung und signierte ausgehende Zustellungen konfigurieren.

Bereitstellung

Produktionsorientierte Hinweise für eine einzelne hs-sql-agent-Instanz, öffentliche MCP-Routen, Persistenz und Telemetrie.

Verteilte Bereitstellung

Anforderungen an gemeinsam genutzten Zustand beim Betrieb mehrerer hs-sql-agent-Instanzen hinter einem Service-Endpunkt.

Sicherheit

OIDC SSO und TOTP MFA

Enterprise-OIDC-Identität, Claim-Zuordnungen, Rollen-Provisionierung, MFA-Regeln und persistente Data-Protection-Keys konfigurieren.

Sicherheitsübersicht

Serverseitige Kontrollen, die Datenbank-Governance außerhalb des LLM halten, und die Betriebseinstellungen, die diese Kontrollen schützen.

Entwicklung

Architektur und Beitragsablauf

Überblick für Beitragende über Repository-Struktur und Regeln für Änderungen an Compiler, Server, Frontend und Dokumentation.