Documentation

Prise en main

Introduction

Découvrez le rôle de hs-sql-agent, sa place entre les clients MCP et les bases de données, et le fonctionnement de sa frontière de sécurité.

Démarrage rapide

Choisissez une méthode d’installation, démarrez hs-sql-agent et connectez votre premier client MCP.

MCP

Connexion d’un client MCP

Créez une clé MCP, copiez la configuration client générée et vérifiez Elicitation avant d’activer DML.

Référence des outils MCP

Contrats formels des outils MCP intégrés de hs-sql-agent 2.0.2, paramètres, réponses, autorisation et frontières de risque.

Compilateur SQL

Modèle d’exécution SQL

Comment hs-sql-agent transforme du SQL non fiable en instructions validées et adaptées au moteur avant exécution.

Safe DML

Prévisualiser l’impact, lier l’approbation, revérifier les lignes ciblées et ne valider que la modification exacte approuvée par une personne.

Dialectes de base de données

Les six moteurs derrière l’interface MCP commune et la signification d’une prise en charge volontairement bornée des dialectes SQL.

Référence du support SQL

Résumé lisible de la grammaire SQL et des capacités des moteurs dans hs-sql-agent 2.0.2.

Administration

Vue d’ensemble du panneau d’administration

Le plan de contrôle opérateur pour l’accès aux bases de données, les identifiants MCP, l’identité, l’autorisation, l’audit, les politiques de sécurité et l’exploitation du runtime.

Gestion des bases de données

Configurer et exploiter les connexions de base de données exposées par hs-sql-agent 2.0.2.

Clés MCP

Émettre, restreindre, renouveler, dupliquer et révoquer les identifiants MCP dans hs-sql-agent 2.0.2.

Outils personnalisés

Construire et publier des outils MCP Query ou DML spécialisés sans créer de contournement de politique autour de hs-sql-agent.

Métadonnées sémantiques

Enrichir la découverte de base avec la sémantique des tables et colonnes, les relations et les métriques dans hs-sql-agent 2.0.2.

Membres et rôles

Gérer les utilisateurs Admin, les sessions, l’attribution de rôles et le cycle de vie des rôles dans hs-sql-agent 2.0.2.

Permissions

Comprendre le modèle d’autorisation chemin + action utilisé par les opérations Admin de hs-sql-agent 2.0.2.

Audit

Interroger, synthétiser, exporter et conserver les enregistrements d’audit hs-sql-agent depuis le plan de contrôle Admin.

Politiques de sécurité

Configurer depuis le plan de contrôle Admin les politiques runtime SQL, DML, limitation de débit et concurrence de hs-sql-agent 2.0.2.

Opérabilité

Inspecter les métriques d’exécution, la santé des bases, l’usage des clés MCP et les livraisons sortantes dans hs-sql-agent 2.0.2.

Intégration

Intégration ASP.NET Core

Composer les capacités HsSqlAgent.Server dans une application ASP.NET Core existante, avec authentification du host ou expérience Admin intégrée facultative.

Exploitation

Référence de configuration

Référence issue du code source pour les variables d’environnement et la configuration runtime de hs-sql-agent 2.0.2.

Observabilité et opérations d’audit

Configurer les sondes de santé, seuils de requêtes lentes, Prometheus, OTLP, la rétention d’audit et les livraisons sortantes signées.

Déploiement

Recommandations de production pour une instance hs-sql-agent, le routage MCP public, la persistance et la télémétrie.

Déploiement distribué

Exigences d’état partagé pour exécuter plusieurs instances hs-sql-agent derrière un même endpoint de service.

Sécurité

SSO OIDC et MFA TOTP

Configurer l’identité OIDC d’entreprise, la correspondance des revendications, le provisionnement des rôles, la politique MFA et les clés persistantes de protection des données.

Vue d’ensemble de la sécurité

Les contrôles côté serveur qui maintiennent la gouvernance des bases de données hors du LLM et les paramètres d’exploitation qui les protègent.

Développement

Architecture et parcours de contribution

Cartographie du dépôt pour les contributeurs et règles de modification du compilateur, du serveur, du frontend et de la documentation.