Skip to main content
Glama
dbatools-mcp-server

dbatools-mcp-server

Official
by dataplat

dbatools-mcp-server

Install in VS Code Install in VS Code Insiders

A Model Context Protocol (MCP) server for the dbatools PowerShell module.

Exposes dbatools commands as MCP tools so AI assistants (GitHub Copilot, Claude, etc.) can discover, explain, and execute dbatools commands directly — with all metadata sourced from dbatools' own comment-based help.


Features

  • list_dbatools_commands — search commands by verb, noun, keyword, or risk level

  • get_dbatools_command_help — full normalized help (synopsis, parameters, examples) from Get-Help -Full

  • invoke_dbatools_command — execute any dbatools command with safe parameter validation, risk gating, and structured JSON output

  • check_dbatools_environment — verify PowerShell + dbatools installation, index freshness, and version alignment

  • Tool annotations — each tool declares readOnlyHint / destructiveHint / idempotentHint / openWorldHint so MCP clients (e.g. VS Code) can surface risk in the UI before a tool is even called

  • Resources — browse dbatools://command/{name} to read any command's full normalized help as structured JSON, independent of the chat-oriented tool responses

  • Persistent PowerShell session — invoke_dbatools_command reuses one long-lived pwsh process with dbatools pre-imported instead of spawning (and re-importing dbatools into) a fresh process on every call

  • Version mismatch detection — warns when installed dbatools version differs from the indexed version

  • Safe mode — non-readonly commands require explicit confirm: true to execute

  • SQL Authentication support — pass SqlCredential: { username, password } for SQL auth instances


Related MCP server: mcp-sqlserver

Prerequisites

Install-Module dbatools -Scope CurrentUser

Quick Start

# 1. Clone the repo
git clone https://github.com/Dataplat/dbatools-mcp-server.git
cd dbatools-mcp-server

# 2. Install Node dependencies
npm install

# 3. Generate the help index from your local dbatools installation
npm run refresh-help

# 4. Build
npm run build

Then open the folder in VS Code — the .vscode/mcp.json file automatically registers the MCP server.


Connecting to VS Code

The included .vscode/mcp.json registers the server as a local STDIO MCP server. Open this folder in VS Code and the server will appear in the GitHub Copilot MCP panel.

{
  "servers": {
    "dbatools": {
      "type": "stdio",
      "command": "node",
      "args": ["${workspaceFolder}/dist/server.js"],
      "env": {
        "DBATOOLS_SAFE_MODE": "true",
        "MAX_OUTPUT_ROWS": "100",
        "COMMAND_TIMEOUT_SECONDS": "60"
      }
    }
  }
}

Configuration

All settings are controlled via environment variables (set in .vscode/mcp.json or your shell):

Variable

Default

Description

PWSH_EXE

pwsh

Path to PowerShell executable

DBATOOLS_SAFE_MODE

true

When true, non-readonly commands require confirm: true

MAX_OUTPUT_ROWS

100

Maximum rows returned per command execution

COMMAND_TIMEOUT_SECONDS

60

Seconds before PowerShell process is killed

DBATOOLS_PERSISTENT_SESSION

true

When true, invoke_dbatools_command reuses one long-lived PowerShell process (dbatools pre-imported) instead of spawning a new process per call. Set to false to force a fresh process per call.


Refreshing the Help Index

The help index (generated/dbatools-help.json) is generated from your locally installed dbatools module. Re-run whenever dbatools is updated:

Update-Module dbatools -Scope CurrentUser
npm run refresh-help

The server detects version mismatches at runtime and warns you when the index is stale.


Risk Levels

Commands are automatically classified by verb:

Risk Level

Verbs

Behavior

readonly

Get, Test, Find, Compare, …

Always allowed

change

Set, New, Add, Copy, Enable, …

Requires confirm: true in safe mode

destructive

Remove, Drop, Disable, Reset, …

Requires confirm: true in safe mode

Each risk tier maps to standard MCP tool annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint), so compatible clients can surface risk in their UI before a tool is even invoked. invoke_dbatools_command is a generic dispatcher that can run any command, so its annotation conservatively reflects the worst case (destructiveHint: true) — the actual per-command risk is still enforced at runtime by the safe-mode gate.


Resources

Besides the four tools, the server exposes every indexed command as an MCP resource at dbatools://command/{name} (e.g. dbatools://command/Get-DbaDatabase), returning the same normalized help record as structured JSON — useful for clients that browse/ground on resources rather than calling a tool. The browsable resource list excludes PowerShell aliases (e.g. Attach-DbaDatabase, an alias for Mount-DbaDatabase) since they just forward to another command's help.


Persistent PowerShell Session

By default, invoke_dbatools_command reuses a single long-lived pwsh process with dbatools pre-imported, instead of spawning a fresh process (and re-importing dbatools) on every call. This removes the ~1-2s+ process-startup and module-import cost from every invocation after the first.

A couple of things to be aware of:

  • Crash/timeout recovery: if a command times out or the session process crashes, it is killed and discarded; the next call transparently starts a fresh session (paying the import cost once more). The call that triggered the failure is not automatically retried.

  • Cross-call state: dbatools caches some state (e.g. SMO connections via Connect-DbaInstance) within a PowerShell session. With a persistent session, that caching is now visible across tool calls within one MCP server run, where previously every call was fully isolated. Each individual script still runs in its own scope, so plain variables never leak between calls — only dbatools' own internal caching behavior is affected.

Set DBATOOLS_PERSISTENT_SESSION=false to disable this and go back to one fresh process per call.


SQL Authentication

For SQL-auth-only instances (e.g. Docker), pass credentials via the SqlCredential parameter:

{
  "SqlInstance": "localhost,1433",
  "SqlCredential": { "username": "<SqlLogin>", "password": "YourPassword" }
}

Project Structure

dbatools-mcp-server/
├── src/
│   ├── server.ts              # MCP server entry point, tool/resource definitions
│   ├── powershell.ts           # One-shot PowerShell process runner, health checks, version detection
│   ├── powershell-session.ts   # Persistent PowerShell session (long-lived process, dbatools pre-imported)
│   ├── help-indexer.ts         # Help manifest loader and command search
│   ├── tool-registry.ts        # Risk classification, tool annotations, safe argument builder
│   └── types.ts                # Shared TypeScript interfaces
├── scripts/
│   └── refresh-help.ps1       # Generates generated/dbatools-help.json
├── generated/                 # Help index (gitignored, generated locally)
├── .vscode/
│   └── mcp.json               # VS Code MCP local server registration
└── dist/                      # Compiled output (gitignored)

Contributing

Contributions are welcome! Please open an issue first for significant changes.

This project follows the same community spirit as dbatools.


License

MIT — © 2026 DataPlat contributors

Available Tools

4 tools
check_dbatools_environmentA
Read-onlyIdempotent

Verify that PowerShell and the dbatools module are installed and report the help-index status.

Inputs: no named parameters.

get_dbatools_command_helpA
Read-onlyIdempotent

Get the full normalized help for a specific dbatools command, including parameters and examples sourced from comment-based help.

Inputs: commandName (required).

invoke_dbatools_commandA
Destructive

Execute a dbatools command via PowerShell and return structured JSON output.

SAFETY: For any destructive or change command (Remove, Drop, Disable, Reset, etc.), always explain the consequences to the user and ask for explicit confirmation before running. Only proceed with confirm:true if the user has clearly confirmed their intent. Respect DBATOOLS_SAFE_MODE: never bypass safety checks. For any command that modifies or deletes data, double-check with the user before proceeding. Show the exact command and output for transparency. Non-readonly commands require confirm:true when safe mode is enabled.

Inputs: commandName (required), confirm, parameters, selectProperties.

list_dbatools_commandsA
Read-onlyIdempotent

Search and list dbatools commands. Filter by verb, noun, keyword, or risk level.

Inputs: noun, verb, limit, keyword, +1 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.9/5.0

    Scored across 4 tools

    Disambiguation5/5

    Each tool maps to a distinct phase of the workflow: environment verification, command discovery, documentation lookup, and execution. list_dbatools_commands (search) versus get_dbatools_command_help (full help for one known command) are clearly separated by their descriptions.

    Naming Consistency5/5

    All four tools follow the same snake_case verb_dbatools_noun pattern: get_, list_, invoke_, check_. The domain prefix is applied uniformly, making the set predictable.

    Tool Count4/5

    Four tools cover the essential wrapper surface (discover, inspect, run, verify) without redundancy. It is on the lean side, but for a single-module gateway that is reasonable rather than a mismatch.

    Completeness4/5

    Discovery, help, execution, and environment validation give a complete basic lifecycle with no dead ends. Minor gaps exist, such as refreshing/rebuilding the help index or batch invocation, but agents can work around them via invoke_dbatools_command.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol server that provides comprehensive access to Microsoft SQL Server databases, enabling Language Models to inspect schemas, execute queries, manage database objects, and perform advanced database operations.
      8
      -
    • A
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol (MCP) server that enables AI agents to interact with Microsoft SQL Server databases through secure, intelligent database operations. This server provides comprehensive CRUD capabilities, schema introspection, stored procedure execution, transaction management, and bulk opera
      1,560 npm
      47
      MIT
    • F
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol (MCP) server that provides database operations as tools for LLM-powered applications. Supports PostgreSQL, MySQL, and MongoDB databases with connection pooling and flexible result formatting.
      -