Mcpsqlserver

🚀 SQL Server MCP Server for Windsurf IDE

An independent MCP (Model Context Protocol) server written in C#, providing SQL Server integration capabilities for the Windsurf IDE.

🚀 Quick Start

✨ Features

• SQL Server connectivity
• Database schema exploration
• Table and view inspection
• Column metadata retrieval
• Stored procedure enumeration
• SQL query execution
• Stored procedure execution
• Debug mode for troubleshooting
• Configurable log path

📦 Installation

Prerequisites

• .NET 9.0 SDK or higher
• SQL Server instance (local or remote)
• SQL Server client tools

Setup Steps

1. Build the project:

dotnet build

2. Configure the application:
   • Copy appsettings.example.json to appsettings.json.
   • Update the connection string and other SQL Server details in appsettings.json:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=your-server;Database=master;User ID=your-username;Password=your-password;TrustServerCertificate=True"
  },
  "LogPath": "C:\\Path\\To\\Your\\LogDirectory\\",
  "DebugMode": "false"
}

3. Configure the MCP server in Windsurf:
   • Copy windsurf_mcp_config.json to your Windsurf MCP configuration file (usually located at ~/.codeium/windsurf/mcp_config.json).
   • Update the path to point to your built executable:

{
  "mcpServers": {
    "sqlMcpService": {
      "command": "path/to/your/MCPSqlServer.exe",
      "args": [],
      "description": "SQL Server MCP Service"
    }
  }
}

4. Set up GitHub integration:
   • Create a new GitHub repository for the project.
   • Initialize a new Git repository in the project directory using git init.
   • Add your GitHub repository as a remote using git remote add origin <repository-url>.
   • Push changes to the remote repository using git push -u origin master.

💻 Usage Examples

Basic Usage

You can start using the server after completing the above setup steps.

📚 Documentation

Configuration Options

The appsettings.json file contains the following configuration options:

Publishing

You can publish a self - contained executable:

dotnet publish -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true

This will generate a single executable file.

Code Structure

The application is organized as follows:

• Program.cs: Main entry point and request handling.
• JsonRpcHandler.cs: Handles the JSON - RPC protocol and distributes requests.
• Configuration is loaded from appsettings.json.
• Logs are written to the file specified by the LogPath setting.

🔧 Technical Details

The server is implemented in C# and uses the JSON - RPC protocol for communication. It interacts with the SQL Server database through the provided connection string and performs various database - related operations.

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

❗ Error Handling

Common error codes:

• invalid_request: Invalid JSON model or missing required fields.
• connection_failed: Failed to connect to SQL Server.
• missing_parameter: Missing required parameters.
• query_execution_error: Error occurred while executing an SQL query.
• database_not_found: The specified database does not exist.
• table_not_found: The specified table does not exist.