mssql-mcp-server
by: c0h1b4
mssql mcp server
📌Overview
Purpose: To provide a Model Context Protocol (MCP) server that facilitates connections and interactions with Microsoft SQL Server databases.
Overview: The MSSQL MCP Server is designed to execute SQL queries and manage database connections effectively. It allows developers to integrate database functionality within applications seamlessly, leveraging the full capabilities of Microsoft SQL Server.
Key Features:
-
SQL Query Execution: Allows users to execute SQL queries on MSSQL databases, providing parameters for flexible connection options including full connection strings or individual settings.
-
Configurable Connection Parameters: Users can specify connection details such as host, port, database name, username, and password, along with options for encryption and certificate trust.
MSSQL MCP Server
A Model Context Protocol (MCP) server for connecting to Microsoft SQL Server databases. This server provides tools for executing SQL queries and managing database connections.
Installation
npm install mssql-mcp-server
Usage
Add the server to your MCP settings configuration file:
{
"mcpServers": {
"mssql": {
"command": "mssql-mcp-server",
"env": {
"MSSQL_CONNECTION_STRING": "Server=localhost;Database=master;User Id=sa;Password=yourpassword;",
"MSSQL_HOST": "localhost",
"MSSQL_PORT": "1433",
"MSSQL_DATABASE": "master",
"MSSQL_USER": "sa",
"MSSQL_PASSWORD": "yourpassword",
"MSSQL_ENCRYPT": "false",
"MSSQL_TRUST_SERVER_CERTIFICATE": "true"
}
}
}
}
Tools
query
Execute a SQL query on a MSSQL database.
Parameters
connectionString
(string, optional): Full connection string (alternative to individual parameters)host
(string, optional): Database server hostnameport
(number, optional): Database server port (default: 1433)database
(string, optional): Database name (default: master)username
(string, optional): Database usernamepassword
(string, optional): Database passwordquery
(string, required): SQL query to executeencrypt
(boolean, optional): Enable encryption (default: false)trustServerCertificate
(boolean, optional): Trust server certificate (default: true)
Either connectionString
OR (host
+ username
+ password
) must be provided.
Example
const result = await use_mcp_tool({
server_name: 'mssql',
tool_name: 'query',
arguments: {
host: 'localhost',
username: 'sa',
password: 'yourpassword',
query: 'SELECT * FROM Users',
},
});
Development
npm install
npm run dev
npm run build
npm test
npm run lint
npm run format
License
MIT