hs-sql-agent
2.0.2
Documentation 2.0.2
Version de la documentation
2.0.2
2.0.2 Prise en charge 2.0.3 Actuelle
Documentation Prise en main

Démarrage rapide

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

~5 min
RecommandéDocker Compose Lancer le service auto-hébergé complet avec la configuration Compose du dépôt.
~10 min
ASP.NET Core / NuGet Intégrer l’exécution MCP et, si nécessaire, l’interface d’administration dans une application ASP.NET Core existante.
après installation
Connecter un client MCP Créer une clé à périmètre limité et connecter Claude Desktop, Cursor ou un autre client Streamable HTTP.

Docker Compose

  1. Créer le fichier d’environnement

    Copiez l’exemple versionné afin de conserver une configuration explicite et révisable.

    cp .env.example .env
  2. Remplacer les secrets de signature

    Définissez HMAC_KEY et JWT_KEY avec deux secrets distincts d’au moins 32 octets.

    Les valeurs de .env.example sont des exemples. Ne les déployez pas telles quelles.

  3. Démarrer le service

    Lancez la pile mono-instance par défaut.

    docker compose up -d
  4. Ouvrir le panneau d’administration

    Par défaut, l’application écoute sur le port 8080.

    Pour une installation locale, ouvrez http://localhost:8080 et terminez la configuration du premier administrateur.

Créer votre première clé MCP

  1. Ouvrir Runtime → MCP Keys

    Les clés constituent la frontière d’identité et d’autorisation MCP.

  2. Choisir la base et le périmètre d’outils

    Associez la clé à une entrée Database Management et n’exposez que les outils nécessaires au client.

  3. Copier la clé en clair

    La boîte de dialogue de cycle de vie affiche le secret nouvellement créé pour vous permettre de le copier ; conservez-le dans le magasin de secrets du client.

  4. Utiliser la configuration client générée

    Vous pouvez aussi envoyer le secret dans X-MCP-Server-Key vers le point de terminaison Streamable HTTP.

Le point de terminaison MCP par défaut est /mcp. Pour un client situé hors de la machine locale, définissez MCP_PUBLIC_ENDPOINT sur l’URL HTTP ou HTTPS absolue accessible de l’extérieur, en incluant /mcp.

Pour continuer

Connexion d’un client MCP En-têtes, configuration Streamable HTTP, règles du point de terminaison public et compatibilité DML Elicitation.
Modèle d’exécution SQL Comprendre la frontière analyse → validation → vérification des capacités → compilation avant d’exposer SQL à un agent.
Gestion des bases de données Créer les connexions aux moteurs, tester la connectivité et comprendre comment les clés MCP sont associées aux bases.
Configuration de production Examiner l’identité, les limites de débit, la rétention, l’état distribué, la télémétrie et les secrets.