Documentation

01

Getting Started

2

01

Introduction

What hs-sql-agent is, where it sits between MCP clients and databases, and how the security boundary works.

02

Quick Start

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

02

MCP

2

01

MCP Client Onboarding

Connect Streamable HTTP MCP clients, configure the public endpoint, and verify Elicitation before enabling DML.

02

MCP Tools Reference

Formal hs-sql-agent 2.0.1 built-in MCP tool contracts, parameters, responses, authorization, and risk boundaries.

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

Preview, bind approval, revalidate the row set, and commit only the exact mutation a human approved.

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 2.0.1.

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 2.0.1.

03

MCP Keys

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

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 2.0.1.

06

Members & Roles

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

07

Permissions

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

08

Audit

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

09

Security Policies

Configure the hs-sql-agent 2.0.1 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 2.0.1.

05

Integration

1

01

ASP.NET Core Integration

Compose HsSqlAgent.Server capabilities inside an existing ASP.NET Core application, with host-owned authentication or the optional built-in Admin experience.

06

Operations

4

01

Configuration Reference

Source-backed environment and runtime configuration reference for hs-sql-agent 2.0.2.

02

Observability and Audit Operations

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

03

Deployment

Production-oriented guidance for a single hs-sql-agent instance, public MCP routing, persistence, and telemetry.

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 and Contribution Flow

A contributor-oriented map of the repository and the rules for changing compiler, server, frontend, and documentation behavior.

09

Reference

3

01