# joyceerhl/vscode-mssql-chat architecture

> Architecture diagram of the GitHub repository joyceerhl/vscode-mssql-chat, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/joyceerhl/vscode-mssql-chat
- Repository: https://github.com/joyceerhl/vscode-mssql-chat

## Overview

##### Project type and purpose
- This is a Visual Studio Code extension named “SQL Chat” written in TypeScript.
- Its purpose is to register a Copilot Chat participant (`@mssql`), provide a “Summarize Database” smart action, and supply a chat variable (`#database`) by integrating with the MS SQL VS Code extension and a live SQL Server database.

##### File structure
- Top-level files:
- package.json / package-lock.json: extension metadata, dependencies, and scripts.
- tsconfig.json & webpack.config.js: TypeScript compiler and bundler configuration.
- `.vscodeignore`, `.gitignore`: files excluded from packaging or VCS.
- README.md, CHANGELOG.md, vsc-extension-quickstart.md: documentation and changelog.
- `src/` directory:
- extension.ts: main activation entry point that hooks into VS Code’s extension API.
- utils.ts: helper functions for chat message parsing, database summarization logic, etc.
- TypeScript definition files (`*.d.ts`): provide proposed API typings for VS Code’s chat participant and variable APIs.

##### README for additional insights
- Features enumerated: registration of `@mssql` participant, a smart action to summarize the database, and a `#database` variable.
- Setup instructions reveal dependencies on the MS SQL extension and on VS Code Insiders with proposed APIs enabled.
- No external web service calls—interaction is local: VS Code ↔ MS SQL extension ↔ SQL Server database.

##### Main components
a. Visual Studio Code Host
b. Copilot Chat API (proposed VS Code Chat APIs)
c. SQL Chat Extension (this project)
- Activation & registration logic (extension.ts)
- Chat participant handler (`@mssql`)
- Smart Action provider (Summarize Database)
- Chat variable resolver (`#database`)
- Utility module (utils.ts)
d. MS SQL VS Code Extension (fork)
e. SQL Server database instance

##### Relationships and interactions
- On activation: extension.ts registers chat participant, smart action, and variable resolver with the Copilot Chat API.
- When user types `@mssql` in chat: Copilot Chat API calls into SQL Chat’s participant handler → uses MS SQL extension API to inspect the database schema → utils code formats a reply.
- When the “Summarize Database” smart action is invoked: SQL Chat calls MS SQL extension’s API to retrieve metadata → utils to summarize → returns text to Copilot Chat.
- When chat variable `#database` is used: Copilot asks SQL Chat variable resolver, which queries MS SQL and returns substitution text.

##### Architectural patterns and design principles
- Extension activation lifecycle: leverage VS Code’s event-driven extension host model.
- Separation of concerns: extension.ts for registration/workflow orchestration, utils.ts for pure logic.
- Dependency on external extension (MS SQL) via VS Code extension API—no direct database driver code inside this project.
- Build pipeline: TypeScript→webpack bundle→VSIX package.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "VS Code Host"
        direction TB
        CPAPI("Copilot Chat API (proposed)"):::platform
        MSExtAPI("MS SQL Extension API"):::platform

        subgraph "SQL Chat Extension"
            direction TB
            Activation["Activation & Registration Logic"]:::extension
            Participant["Chat Participant Handler (@mssql)"]:::extension
            SmartAction["Smart Action Provider (Summarize Database)"]:::extension
            VarResolver["Chat Variable Resolver (#database)"]:::extension
            Utils["Utility Module"]:::extension
        end

        subgraph "Project Config & Build"
            direction TB
            Package["package.json"]:::config
            TSConfig["tsconfig.json"]:::config
            Webpack["webpack.config.js"]:::config
            D1["vscode.proposed.chatParticipantAdditions.d.ts"]:::config
            D2["vscode.proposed.chatVariableResolver.d.ts"]:::config
        end
    end

    SQLDB(("SQL Server Database")):::db

    %% Registration and activation
    Activation -->|"register participant, actions, resolver"| CPAPI

    %% Participant flow
    CPAPI -->|"invoke @mssql participant"| Participant
    Participant -->|"use MS SQL API"| MSExtAPI
    MSExtAPI -->|"query schema"| SQLDB
    SQLDB -->|"schema data"| MSExtAPI
    MSExtAPI -->|"format reply"| Participant
    Participant -->|"send response"| CPAPI

    %% Smart action flow
    CPAPI -->|"invoke Summarize Database"| SmartAction
    SmartAction -->|"retrieve metadata via MS SQL API"| MSExtAPI
    MSExtAPI -->|"fetch metadata"| SQLDB
    SQLDB -->|"metadata"| MSExtAPI
    MSExtAPI -->|"summarize via Utils"| Utils
    Utils -->|"summary text"| SmartAction
    SmartAction -->|"return summary"| CPAPI

    %% Variable resolver flow
    CPAPI -->|"invoke #database variable"| VarResolver
    VarResolver -->|"query database via MS SQL API"| MSExtAPI
    MSExtAPI -->|"execute query"| SQLDB
    SQLDB -->|"result data"| MSExtAPI
    MSExtAPI -->|"resolve via Utils"| Utils
    Utils -->|"substitution text"| VarResolver
    VarResolver -->|"provide text"| CPAPI

    %% Internal dependencies
    Participant --> Utils
    SmartAction --> Utils
    VarResolver --> Utils

    %% Click events
    click Activation "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/src/extension.ts"
    click Participant "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/src/extension.ts"
    click SmartAction "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/src/extension.ts"
    click VarResolver "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/src/extension.ts"
    click Utils "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/src/utils.ts"
    click Package "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/package.json"
    click TSConfig "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/tsconfig.json"
    click Webpack "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/webpack.config.js"
    click D1 "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/vscode.proposed.chatParticipantAdditions.d.ts"
    click D2 "https://github.com/joyceerhl/vscode-mssql-chat/blob/main/vscode.proposed.chatVariableResolver.d.ts"

    classDef platform fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef extension fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
    classDef db fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef config fill:#FFFACD,stroke:#333,stroke-width:1px
```
