SQL Server MCP Server - Connect and query Microsoft SQL Server databases via MCP
npm install @ggball/mcp-sqlserverA Model Context Protocol (MCP) server for connecting to and querying Microsoft SQL Server databases, built with TypeScript and Node.js.
MCP (Model Context Protocol) is an open protocol that allows AI assistants to securely and standardly interact with external data sources and tools. Through MCP servers, AI assistants can:
- Directly connect to databases to execute queries
- Call external APIs to get real-time data
- Access file systems and cloud storage
- Execute custom business logic
MCP architecture contains two core components:
- MCP Client: Built into AI assistants (like Claude Desktop), responsible for communicating with servers
- MCP Server: Independent processes that provide specific tools and data access capabilities
- List all available databases
- List all tables in a specific database
- Get table structure information (columns, data types, primary keys, etc.)
- Execute safe SELECT queries (limited to 1000 rows)
- Get table index information
- Get table statistics (row count, size, etc.)
- Connection pool management for improved performance
``bash`
npm install -g @ggball/mcp-sqlserver
After global installation, the mcp-sqlserver command will be available system-wide.
`bash`
npx @ggball/mcp-sqlserver
#### 1. System Requirements
- Node.js 18.0.0 or higher
- npm 9.0.0 or higher
- SQL Server (any version)
#### 2. Install Dependencies
`bash`
npm install
`bash`
npm run build
Create a .env file or set the following environment variables:
| Environment Variable | Description | Default Value |
|---------------------|-------------|---------------|
| SQLSERVER_HOST | Server address | localhost |SQLSERVER_PORT
| | Port number | 1433 |SQLSERVER_USER
| | Username | sa |SQLSERVER_PASSWORD
| | Password | (empty) |SQLSERVER_DATABASE
| | Default database | master |SQLSERVER_ENCRYPT
| | Enable encryption | true |SQLSERVER_TRUST_SERVER_CERTIFICATE
| | Trust server certificate | true |
`env`
SQLSERVER_HOST=localhost
SQLSERVER_PORT=1433
SQLSERVER_USER=sa
SQLSERVER_PASSWORD=YourPassword123
SQLSERVER_DATABASE=MyDatabase
`bash`
npm start
Or for development with auto-rebuild:
`bash`
npm run dev
#### Config File Location
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json
- Windows: ~/.config/Claude/claude_desktop_config.json
- Linux:
#### Option 1: Using Global Installation (Recommended)
If you installed the package globally:
`json`
{
"mcpServers": {
"sqlserver": {
"command": "mcp-sqlserver",
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
#### Option 2: Using npx
`json`
{
"mcpServers": {
"sqlserver": {
"command": "npx",
"args": ["@ggball/mcp-sqlserver"],
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
#### Option 3: From Source
`json`
{
"mcpServers": {
"sqlserver": {
"command": "node",
"args": ["/path/to/mcp-sqlserver-npm/dist/index.js"],
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
Restart Claude Desktop after configuration.
#### Config File Location
- macOS/Linux: ~/.config/claude-code/config.json%APPDATA%\claude-code\config.json
- Windows:
#### Option 1: Using Global Installation (Recommended)
`json`
{
"mcpServers": {
"sqlserver": {
"command": "mcp-sqlserver",
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
#### Option 2: Using npx
`json`
{
"mcpServers": {
"sqlserver": {
"command": "npx",
"args": ["@ggball/mcp-sqlserver"],
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
#### Option 3: From Source
`json`
{
"mcpServers": {
"sqlserver": {
"command": "node",
"args": ["/path/to/mcp-sqlserver-npm/dist/index.js"],
"env": {
"SQLSERVER_HOST": "localhost",
"SQLSERVER_PORT": "1433",
"SQLSERVER_USER": "sa",
"SQLSERVER_PASSWORD": "YourPassword123",
"SQLSERVER_DATABASE": "MyDatabase"
}
}
}
}
Restart Claude Code after configuration.
Lists all SQL Server databases (excluding system databases).
``
Tool name: list_databases
Parameters: None
Example:
``
List all available databases
Lists all tables in a specific database.
``
Tool name: list_tables
Parameters:
- database (required): Database name
- schema (optional): Schema name, defaults to "dbo"
Example:
``
List all tables in MyDatabase
Gets table structure information including columns, data types, nullable, primary keys, etc.
``
Tool name: describe_table
Parameters:
- database (required): Database name
- table (required): Table name
- schema (optional): Schema name, defaults to "dbo"
Example:
``
Show the structure of the Users table in MyDatabase
Executes SQL SELECT queries (only SELECT and WITH allowed, limited to 1000 rows).
``
Tool name: execute_query
Parameters:
- query (required): SQL query statement
- database (optional): Database name, defaults to configured database
Example:
``
Query users older than 18 from the Users table
Gets index information for a table.
``
Tool name: get_table_indexes
Parameters:
- database (required): Database name
- table (required): Table name
- schema (optional): Schema name, defaults to "dbo"
Example:
``
Get index information for the Users table
Gets table statistics including row count and storage size.
``
Tool name: get_table_stats
Parameters:
- database (required): Database name
- table (required): Table name
- schema (optional): Schema name, defaults to "dbo"
Example:
``
Get statistics for the Users table
`
You: List all available databases
Claude: [calls list_databases] ...
You: Show what tables are in MyDatabase
Claude: [calls list_tables] ...
`
``
You: Query the last 10 orders from Orders table
Claude: [calls describe_table to understand table structure]
[calls execute_query to perform query] ...
``
You: Analyze the structure and indexes of Users table
Claude: [calls describe_table]
[calls get_table_indexes]
[calls get_table_stats] ...
- execute_query tool only allows SELECT and WITH queries
- Automatically blocks statements containing dangerous keywords (DROP, DELETE, UPDATE, etc.)
- Query results are limited to 1000 rows
``
mcp-sqlserver-npm/
├── src/
│ ├── index.ts # Main server entry point
│ ├── config.ts # Configuration management
│ └── connection.ts # Connection pool implementation
├── dist/ # Compiled output
├── package.json
├── tsconfig.json
└── README.md
- npm run build - Compile TypeScriptnpm run dev
- - Compile and run in development modenpm start
- - Run the compiled servernpm run watch
- - Watch mode for TypeScript compilation
- @modelcontextprotocol/sdk - Official MCP SDK for TypeScripttedious
- - SQL Server connector for Node.jszod
- - Schema validationdotenv` - Environment variable management
-
MIT License
- MCP TypeScript SDK GitHub
- NPM Package: @modelcontextprotocol/sdk
- GitHub Repository
- 掘金 - MCP TypeScript SDK 核心概念
- Mojotv.cn - MCP TypeScript SDK 教程