SQL Server Schema Explorer MCP server for AI agents

This MCP server allows you to query SQL Server database schema, including tables, columns, and relationships. It provides a specialized interface for retrieving database metadata that can be integrated with tools like GitHub Copilot.

Prerequisites

Before installing MsSqlMCP, ensure you have:

.NET 9
SQL Server instance

Installation

Clone the repository to your local machine:

git clone https://github.com/username/MsSqlMCP.git

Navigate to the repository directory:
```
cd MsSqlMCP
```
Build the project:
```
dotnet build
```

Configuration

To use MsSqlMCP with Visual Studio Code's Copilot, you need to add the MCP server configuration to your VS Code settings.

Adding to VS Code Settings

Open VS Code and access the settings.json file (File > Preferences > Settings, then click the "Open Settings (JSON)" icon)

Add the following configuration to your settings.json file:

"mcp": {
    "inputs": [],
    "servers": {
        "MsSqlMCP": {
            "type": "stdio",
            "command": "dotnet",
            "args": [
                "run",
                "--project",
                "c:\\{path of repository}\\MsSqlMCP\\MsSqlMCP.csproj"
            ]
        }
    }
}

Replace {path of repository} with the actual path where you cloned the repository.

Usage

Once configured, the MCP server can be used to query your SQL Server database schema. The server provides information about:

Database tables
Column definitions
Primary and foreign key relationships
Indexes and constraints

Example Queries

You can use the MCP server through your configured interface (like GitHub Copilot) to retrieve database schema information:

Get a list of all tables in the database
View the structure of a specific table including its columns
Identify relationships between tables
Analyze index information for performance optimization

The query results will be returned in a structured format that can be used by your development tools for code completion, documentation, or analysis purposes.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.