Dokumentation

Erste Schritte

Einführung

Die Sicherheitsgrenze von hs-sql-agent verstehen und den passenden Nutzungsweg wählen.

Schnellstart

Docker, HsSqlAgent.Hosting oder HsSqlAgent.Server wählen und den ersten MCP-Client verbinden.

MCP

MCP-Client verbinden

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

MCP-Tool-Referenz

Verträge der eingebauten MCP-Tools in hs-sql-agent; die öffentliche Oberfläche wird serverseitig auf fünf Tools festgelegt.

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

Eine oder mehrere Mutationen freigeben, exakte Evidence erneut prüfen und die freigegebene Transaction atomar committen.

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.

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 bereitgestellt werden.

MCP-Schlüssel

MCP-Zugangsdaten in hs-sql-agent 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 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 verwalten.

Berechtigungen

Das Path-and-Action-Autorisierungsmodell für Admin-Operationen in hs-sql-agent 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-Laufzeit über die Admin-Steuerung konfigurieren.

Betriebszustand

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

Integration

ASP.NET-Core-Integration

HsSqlAgent.Hosting bettet das vollständige offizielle Produkt ein; HsSqlAgent.Server dient für eine modulare, vom Host kontrollierte ASP.NET-Core-Integration.

Betrieb

Konfigurationsreferenz

Eigenständiges Docker, Standard-HsSqlAgent.Hosting oder einen modularen HsSqlAgent.Server-Host konfigurieren.

Observability und Audit-Betrieb

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

Bereitstellung

Produktionshinweise für eigenständige, standardmäßig eingebettete und modulare hs-sql-agent-Hosts.

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

Produktkomposition, SQL-Compiler-Grenze und DML-Freigabearchitektur in hs-sql-agent.