Documentation

01

Getting Started

2

01

Introduction

Understand hs-sql-agent's security boundary and choose the right consumption path.

02

Quick Start

Choose Docker, HsSqlAgent.Hosting, or HsSqlAgent.Server and connect your first MCP client.

02

MCP

2

01

MCP Client Onboarding

Issue an MCP key, copy the generated client configuration, and verify Elicitation before enabling DML.

02

MCP Tools Reference

Built-in MCP tool contracts for hs-sql-agent, including atomic multi-statement DML.

03

SQL Compiler

4

01

SQL Execution Model

How hs-sql-agent turns untrusted SQL into validated, provider-specific statements before execution.

02

Safe DML

Approve one or more mutations, revalidate exact evidence, and commit the approved transaction atomically.

03

Database Dialects

The six database providers behind the shared MCP surface and what bounded dialect support means.

04

SQL Support Reference

Human-readable SQL grammar and provider capability summary for hs-sql-agent.

04

Administration

10

01

Admin Panel Overview

The operator control plane for database access, MCP credentials, identity, authorization, audit, security policy, and runtime operations.

02

Database Management

Configure and operate database connections exposed through hs-sql-agent.

03

MCP Keys

Issue, scope, rotate, clone, and revoke MCP credentials in hs-sql-agent.

04

Custom Tools

Build and publish purpose-specific Query or DML MCP tools without creating a policy bypass around hs-sql-agent.

05

Semantic Metadata

Enrich database discovery with table and column semantics, relationships, and metric metadata in hs-sql-agent.

06

Members & Roles

Manage Admin users, sessions, role assignment, and role lifecycle in hs-sql-agent.

07

Permissions

Understand the path-and-action authorization model used by hs-sql-agent Admin operations.

08

Audit

Query, summarize, export, and retain hs-sql-agent audit records from the Admin control plane.

09

Security Policies

Configure the hs-sql-agent runtime SQL, DML, rate-limit, and concurrency policy from the Admin control plane.

10

Operability

Inspect runtime execution metrics, database health, MCP-key usage, and outbound deliveries in hs-sql-agent.

05

Integration

1

01

ASP.NET Core Integration

Choose HsSqlAgent.Hosting for the complete first-party product or HsSqlAgent.Server for a host-owned, modular ASP.NET Core integration.

06

Operations

4

01

Configuration Reference

Configure standalone Docker, standard HsSqlAgent.Hosting, or a modular HsSqlAgent.Server host.

02

Observability and Audit Operations

Configure health probes, slow-query thresholds, Prometheus, OTLP, audit retention, and signed outbound delivery.

03

Deployment

Production deployment guidance for standalone, standard embedded, and modular hs-sql-agent hosts.

04

Distributed Deployment

Shared-state requirements for running multiple hs-sql-agent instances behind one service endpoint.

07

Security

2

01

OIDC SSO and TOTP MFA

Configure enterprise OIDC identity, claim mapping, role provisioning, MFA policy, and persistent data-protection keys.

02

Security Overview

The server-side controls that keep database governance outside the LLM and the operational settings that protect them.

08

Development

1

01

Architecture

Product composition, compiler boundaries, and DML approval architecture in hs-sql-agent.

09

Reference

3

01