Sql MCP Server

🚀 SQL-MCP-Server 中文文檔

一個基於 MCP 框架的 SQL 服務器，用於與 SQL Server 數據庫進行交互，為數據庫操作提供便捷的工具和服務。

🚀 快速開始

啟動步驟

# 安裝依賴項
npm install

# 構建項目
npm run build

# 啟動服務
npm start

📁 項目結構

sql-mcp-server/
├── src/
│   ├── services/       # 應用程序的服務模塊
│   │   └── sql-service.ts
│   ├── tools/          # MCP 工具集
│   │   ├── execute-select-query-tool.ts
│   │   ├── get-database-schema-tool.ts
│   │   └── get-databases-tool.ts
│   └── index.ts        # 服務程序入口文件
├── .env                # 環境變量配置文件
├── package.json
└── tsconfig.json

✨ 主要特性

可用工具

項目提供了以下 SQL 相關的工具：

1. get-databases-tool - 列出 SQL Server 上可用的數據庫
2. get-database-schema-tool - 獲取指定數據庫的架構信息
3. execute-select-query-tool - 執行參數化 SELECT 查詢語句

SQL 服務

SqlService 類提供了核心功能，包括：

• 使用環境變量生成連接字符串
• 對 SQL Server 數據庫執行查詢操作

📦 安裝指南

環境配置

在 .env 文件中配置數據庫連接信息：

DB_SERVER=localhost\SQLEXPRESS
DB_DATABASE=AdventureWorks2019
DB_USERNAME=readonly_user
DB_PASSWORD=StrongPassword!123
DB_PORT=1433

AdventureWorks 示例數據庫

該項目使用的是 AdventureWorks 樣例數據庫。您可從以下鏈接下載並安裝：

• Microsoft 官方文檔: 安裝與配置 AdventureWorks

按照 Microsoft 文檔中的說明下載數據庫備份文件並將其還原到您的 SQL Server 實例中。

創建只讀用戶

為了創建一個僅供讀取數據的用戶：

-- 在 master 數據庫中創建新的登錄賬戶和用戶
CREATE LOGIN readonly_user WITH PASSWORD = 'StrongPassword!123';
GO

-- 切換到目標數據庫AdventureWorks2019
USE AdventureWorks2019;
GO

-- 為MasterDB 登錄創建數據庫用戶
CREATE USER readonly_user FOR LOGIN readonly_user;

-- 將用戶添加到 db_datareader 角色以實現只讀訪問
ALTER ROLE db_datareader ADD MEMBER readonly_user;
GO

⚠️ 重要提示

您需要先使用 SQL Server Management Studio 或通過 CREATE LOGIN 命令在 master 數據庫中創建登錄賬戶，然後再運行上述命令。

📚 詳細文檔

與 VS Code 集成

要在 VS Code 中配置 MCP 服務器，請按照以下步驟操作：

1. 在項目根目錄下創建一個 .vscode/mcp.json 文件：
   • 如果沒有 .vscode 目錄，請先創建
   • 在該目錄中添加 mcp.json 文件，內容如下：

{
  "servers": {
    "sql-mcp-server": {
      "url": "http://localhost:1337/mcp"
    }
  }
}

構建與測試

1. 修改您的工具代碼
2. 運行 npm run build 進行編譯
3. 啟動後，服務器會自動加載您的工具

調試指南

您可以通過以下方式使用 mcp-debug 工具進行調試：

# 在一個終端中啟動服務
npm start

# 在另一個終端中運行 mcp-debug
npx mcp-debug

mcp-debug 工具提供了一個命令行界面，用於：

• 列出 MCP 服務器上的可用工具
• 執行特定參數的工具
• 查看服務器返回的完整結果

學習資源

• MCP 框架官方文檔
• TypeScript 入門指南
• Node.js 官方教程