Documentation

Guides

• Architecture Overview

  The shell extension and the engine run in separate processes. The shell is hosted inside a .NET Framework 4.7.2 VS/SSMS process; the engine is a .NET 10 self-contained executable.

• Configuration Guide

  The configuration file is stored at:

• Deployment Guide

  Tool

• Formatter Reference

  The SQL formatter rewrites T-SQL text according to a formatting profile (.akmlstyle), preserving semantic equivalence. It runs as part of the out-of-process Engine and is invoked via the IPC API.

• IPC API Reference

  All communication between the shell extension and the engine uses MessagePack-framed RpcMessage envelopes. The named pipe is the default transport (used by all SSMS/VS shell extensions today); spec…

• Static Code Analysis Rules

  The analysis engine ships with 120+ rules across 8 categories. Rules run on every keystroke (debounced) and on save.

• Structured Use Cases

  Version: 1.0 | Date: March 2026 | Author: Derived from Phase 1–9 PRDs Coverage: All features across Phase 1 (Foundation & Installer) through Phase 9 (AI Assistance)

• M3 — WebSocket bridge security & threat model

  Spec: 025-m3-bridge-closure (FR-007 / FR-009) PRD: M3-websocket-transport.md Last reviewed: 2026-05-27