MCP Sql

🚀 mcp-sql

mcp-sql 是一個 MCP 服務器，它允許大語言模型（LLMs）查詢 PostgreSQL、SQLite 和 MySQL 數據庫。它是單二進制文件，默認只讀，支持多數據庫。

🚀 快速開始

你可以按照以下步驟快速使用 mcp-sql。

📦 安裝指南

使用以下命令安裝 mcp-sql：

cargo install mcp-sql

💻 使用示例

基礎用法

# 演示模式 — 使用示例數據立即嘗試
mcp-sql --demo

# 單個數據庫
mcp-sql --url postgres://user:pass@localhost/mydb

# SQLite
mcp-sql --url sqlite:path/to/db.sqlite

# 多個數據庫
mcp-sql --url postgres://localhost/app --url sqlite:analytics.db

# 啟用寫操作
mcp-sql --url sqlite:local.db --allow-write

# 自定義行限制
mcp-sql --url mysql://user:pass@localhost/shop --row-limit 500

# 從環境變量中讀取 URL
mcp-sql --url-env DATABASE_URL

# 混合使用 --url 和 --url-env
mcp-sql --url sqlite:local.db --url-env PROD_DB_URL

# 自定義查詢超時時間（默認：30 秒）
mcp-sql --url sqlite:local.db --query-timeout 60

📚 詳細文檔

Claude Code 配置

claude mcp add sql -- mcp-sql --url sqlite:path/to/your.db

或者直接編輯 ~/.claude.json：

{
  "mcpServers": {
    "sql": {
      "type": "stdio",
      "command": "mcp-sql",
      "args": ["--url", "sqlite:path/to/your.db"]
    }
  }
}

Claude Desktop 配置

在你的 Claude Desktop 配置文件（macOS 上為 ~/Library/Application Support/Claude/claude_desktop_config.json）中添加以下內容：

{
  "mcpServers": {
    "sql": {
      "command": "mcp-sql",
      "args": [
        "--url", "postgres://user:pass@localhost/mydb",
        "--url", "sqlite:analytics.db"
      ]
    }
  }
}

Cursor / VS Code 配置

在你的 MCP 配置文件（.cursor/mcp.json 或等效文件）中添加以下內容：

{
  "mcpServers": {
    "sql": {
      "command": "mcp-sql",
      "args": ["--url", "sqlite:path/to/your.db"]
    }
  }
}

工具介紹

當連接多個數據庫時，所有工具都接受一個可選的 database 參數。如果只連接了一個數據庫，則會自動使用該數據庫。

CLI 選項

至少需要一個 --url 或 --url-env（除非使用 --demo）。

🔧 技術細節

安全性

• 默認只讀 — 只允許 SELECT、WITH、SHOW、PRAGMA 和 EXPLAIN 查詢。
• 強制行限制 — 如果查詢中沒有 LIMIT，則會自動注入（默認：100）。
• 查詢超時 — 查詢在配置的超時時間後會被終止（默認：30 秒）。
• 憑證隱藏 — 在 list_databases 輸出中，密碼會被屏蔽。
• PostgreSQL/MySQL — 此外，還使用 SET TRANSACTION READ ONLY 進行數據庫級別的強制限制。

使用 --allow-write 可啟用 INSERT、UPDATE、DELETE、CREATE 和 DROP 操作。

支持的數據庫

📄 許可證

你可以選擇遵循 Apache 許可證 2.0 版 或 MIT 許可證。