🚀 mcp-node-mssql 使用说明

mcp-node-mssql 是一个用于特定场景的工具，可与 Cursor、Windsurf、Claude Code 等集成，为用户提供数据库相关的功能。以下将详细介绍其使用方法、问题排除以及开发相关内容。

🚀 快速开始

Cursor 集成

更多详细信息请参考官方Cursor文档。

1. 打开（或创建）mcp.json文件（它应该位于~/.cursor/mcp.json或<项目根目录>/.cursor/mcp.json，但具体位置请参见Cursor文档以获取更多细节）。
2. 添加以下信息并保存文件：

{
  "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 集成

更多详细信息请参考官方Windsurf文档。

1. 打开Windsurf MCP配置面板。
2. 点击添加自定义服务器。
3. 添加以下信息并保存文件：

{
  "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 集成

更多详细信息请参考官方Claude Code文档。 你可以从Claude Code CLI中添加一个新的MCP服务器。但直接修改JSON文件更简单！

1. 打开Claude Code配置文件（它应该位于~/.claude.json）。
2. 在projects > mcpServers部分找到位置并添加以下信息，然后保存文件：

{
  "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>"
        }
      }
    }
  }
}

📦 安装指南

安装依赖

npm install

构建项目

npm run build

本地开发运行

要测试你本地开发版本的MCP服务器而不是使用发布的包，请按照以下步骤操作：

1. 构建项目：

npm run build

2. 创建或修改你的mcp.json文件以引用你本地构建的路径：

{
  "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. 在终端中运行：

npx mcp-node-mssql

这样，你就可以在本地测试和调试MCP服务器了。

📚 详细文档

在进行任何操作之前，请确保你正在使用最新版本！ 如果你在使用此MCP服务器时遇到问题，请在GitHub上打开一个问题！