hs-sql-agent
2.0.2
Docs 2.0.2
Documentation version
2.0.2 Latest
2.0.2 Latest
Docs Getting Started

Quick Start

Choose a setup path, run hs-sql-agent, and connect your first MCP client.

~5 min
RecommendedDocker Compose Run the complete self-hosted service with the repository Compose setup.
~10 min
ASP.NET Core / NuGet Embed the MCP runtime and optional Admin UI inside an existing ASP.NET Core application.
after install
Connect an MCP client Issue a scoped key and connect Claude Desktop, Cursor, or another Streamable HTTP client.

Docker Compose

  1. Create your environment file

    Copy the checked-in example so configuration stays explicit and reviewable.

    cp .env.example .env
  2. Replace the signing secrets

    Set HMAC_KEY and JWT_KEY to different, unique secrets of at least 32 bytes.

    The values in .env.example are placeholders. Do not deploy them unchanged.

  3. Start the service

    Launch the default single-instance stack.

    docker compose up -d
  4. Open the Admin Panel

    The default application listener is port 8080.

    For a local setup, open http://localhost:8080 and complete the first administrator setup.

Issue your first MCP key

  1. Open Runtime → MCP Keys

    Keys are the MCP identity and authorization boundary.

  2. Choose the database and tool scope

    Bind the key to one Database Management entry and expose only the tools the client needs.

  3. Copy the plaintext key

    The lifecycle dialog displays the newly issued secret for you to copy; keep it in the client secret store.

  4. Use the generated client configuration

    Or send the secret as X-MCP-Server-Key to the Streamable HTTP endpoint.

The default MCP endpoint is /mcp. For clients outside the local machine, set MCP_PUBLIC_ENDPOINT to the externally reachable absolute HTTP or HTTPS URL, including /mcp.

Where to go next

MCP client onboarding Headers, Streamable HTTP configuration, public endpoint rules, and DML Elicitation compatibility.
SQL execution model Understand the parse → validate → capability proof → compile boundary before exposing SQL to an agent.
Database Management Create provider connections, test connectivity, and understand how MCP keys bind to databases.
Production configuration Review identity, rate limiting, retention, distributed state, telemetry, and secret settings.