MCP Node Mssql

🚀 mcp-node-mssql Usage Instructions

This guide provides a detailed introduction to using the mcp-node-mssql tool, including usage methods, troubleshooting, and development steps.

🚀 Quick Start

Cursor

For more detailed information, please refer to the official Cursor documentation.

1. Open (or create) the mcp.json file (it should be located at ~/.cursor/mcp.json or <project root>/.cursor/mcp.json, but refer to the Cursor documentation for more details).
2. Add the following information and save the file:

{
  "mcpServers": {
    "mssql": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-node-mssql"
      ],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "1433",
        "DB_USERNAME": "<username>",
        "DB_PASSWORD": "<password>",
        "DB_DATABASE": "<database>"
      }
    }
  }
}

Windsurf

For more detailed information, please refer to the official Windsurf documentation.

1. Open the Windsurf MCP Configuration Panel.
2. Click Add Custom Server.
3. Add the following information and save the file:

{
  "mcpServers": {
    "mssql": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-node-mssql"
      ],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "1433",
        "DB_USERNAME": "<username>",
        "DB_PASSWORD": "<password>",
        "DB_DATABASE": "<database>"
      }
    }
  }
}

Claude Code

For more detailed information, please refer to the official Claude Code documentation. You can add a new MCP server from the Claude Code CLI. However, it's simpler to directly modify the JSON file!

1. Open the Claude Code configuration file (it should be located at ~/.claude.json).
2. Find the location in the projects > mcpServers section and add the following information, then save the file:

{
  "projects": {
    "mcpServers": {
      "mssql": {
        "command": "npx",
        "args": [
          "-y",
          "mcp-node-mssql"
        ],
        "env": {
          "DB_HOST": "localhost",
          "DB_PORT": "1433",
          "DB_USERNAME": "<username>",
          "DB_PASSWORD": "<password>",
          "DB_DATABASE": "<database>"
        }
      }
    }
  }
}

💡 Troubleshooting

Before performing any operations, ensure that you are using the latest version! If you encounter issues while using this MCP server, please open an issue on GitHub!

🔧 Development

📦 Installation

npm install

🏗️ Build

npm run build

💻 Local Development Server

To test your locally developed version of the MCP server instead of using the published package, follow these steps:

1. Build the project:

npm run build

2. Create or modify your mcp.json file to reference your local build path:

{
  "mcpServers": {
    "mssql": {
      "command": "node",
      "args": [
        "<your-local-build-path>/mcp-node-mssql/out/main.js"
      ],
      "env": {
        "DB_HOST": "localhost",
        "DB_PORT": "1433",
        "DB_USERNAME": "<username>",
        "DB_PASSWORD": "<password>",
        "DB_DATABASE": "<database>"
      }
    }
  }
}

3. Run in the terminal:

npx mcp-node-mssql

This way, you can test and debug the MCP server locally.