Power your agent
คำสั่งของผู้เผยแพร่เอง ไม่ใช่เอนด์พอยต์ของ PlugMCP
Host a copy with our keys and logs.
npx -y @polarisxb/[email protected]Claude Code ไม่มีลิงก์ติดตั้งสำหรับคำสั่งแบบโลคัล ให้คัดลอกคำสั่งด้านล่างแล้วรันในเทอร์มินัล
claude mcp add polarisxb-sql-mcp -- npx -y @polarisxb/sql-mcp@1.4.0รันในเทอร์มินัล
{ "mcpServers": { "polarisxb-sql-mcp": { "command": "npx", "args": [ "-y", "@polarisxb/[email protected]" ] } }}claude_desktop_config.json
URL แบบรีโมตหรือคำสั่งบนเครื่องของคุณ? การติดตั้งสองแบบต่างกันอย่างไร
รันบน PlugMCP
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
เปิดSQL-MCP 是一个实现了模型上下文协议 (Model Context Protocol, MCP) 的服务器,其核心功能是作为连接大型语言模型 (LLM) 与数据库的桥梁。它允许 LLM 安全、高效地访问数据库信息,包括进行元数据查询、数据采样和只读SQL查询。
本项目当前主要支持 MySQL,并提供 Stdio 和 HTTP 两种灵活的传输方式,既可以作为独立的 HTTP 服务运行,也可以轻松集成到其他开发工具链中。
如需英文版本,请参阅 README.en.md。
SELECT 和 SHOW 等只读 SQL,保障数据安全。searchTables 和 searchColumns 接口,用于快速查找表和列。示例参数(在 MCP Inspector 中选择对应工具并填入 params):
// explainQuery
{ "sql": "SELECT p.id, p.name FROM products p JOIN categories c ON p.category_id=c.id WHERE price>50 ORDER BY p.id LIMIT 5" }
// optimizeQuery
{ "sql": "SELECT * FROM orders WHERE order_date >= NOW() - INTERVAL 7 DAY ORDER BY id LIMIT 20" }
// indexAdvisor
{ "sql": "SELECT p.id FROM products p JOIN categories c ON p.category_id=c.id WHERE p.price>50 ORDER BY p.id LIMIT 5" }
// rewriteQuery
{ "sql": "SELECT id FROM orders ORDER BY id LIMIT 20 OFFSET 100" }
// fixQuery
{ "sql": "SELECT x FROM products", "error": "Unknown column 'x' in 'field list'" }
// doctor(无需参数)
{}
返回说明:上述工具均以 text + resource(application/json) 形式返回;证据 JSON 中包含执行计划/分析/建议/改写等结构化信息,便于二次处理或验证。
您可以选择通过 npm 全局安装,或从源码克隆后构建。
全局安装 (推荐):
npm i -g @polarisxb/sql-mcp
从源码构建:
git clone https://github.com/polarisxb/sql-mcp.git
cd sql-mcp
npm ci
npm run build
根据您的使用场景,选择合适的启动方式。
通过 Stdio (标准输入/输出):
此方式适合在 Cursor 或其他支持命令式 MCP 的工具中进行本地集成。
sql-mcp --type mysql \
--host 127.0.0.1 --port 3306 \
--user root --password your_password --database your_db \
--transport stdio
通过 HTTP:
将 SQL-MCP 作为独立的 HTTP 服务运行,供远程应用调用。
sql-mcp --type mysql \
--host 127.0.0.1 --port 3306 \
--user root --password your_password --database your_db \
--transport http --httpPort 3000
服务将在 http://127.0.0.1:3000/mcp 提供 API 端点。
# 启动(首次会自动初始化示例库 mydb)
docker compose up -d
# 健康检查(应返回 200)
curl -i http://127.0.0.1:3001/health
mysql:8 暴露 3306,sql-mcp 暴露为 http://127.0.0.1:3001/mcp。docker-compose.yml 中调整端口映射。# 本地构建版(支持 --dsn)
npm run build
node dist/cli.js --transport stdio --dsn "mysql://root:[email protected]:3306/mydb"
# 已发布包(npx,不支持 --dsn,用显式参数)
npx -y @polarisxb/sql-mcp --transport stdio \
--type mysql --host 127.0.0.1 --port 3306 \
--user root --password root --database mydb
npx -y @modelcontextprotocol/inspector
http://127.0.0.1:3001/mcplistTables、getTableSchema、getSampleData、executeQuery、searchTables、searchColumns在 Cursor 中,通过配置 mcp.json 文件即可轻松集成 SQL-MCP。
配置文件路径:
%USERPROFILE%\\.cursor\\mcp.json~/.cursor/mcp.json这是最简单直接的集成方式,无需手动启动服务。
使用 npx (无需全局安装):
{
"mcpServers": {
"sql-mcp-server": {
"command": "npx",
"args": ["-y", "@polarisxb/sql-mcp"],
"env": {
"SQL_MCP_DB_TYPE": "mysql",
"SQL_MCP_DB_HOST": "127.0.0.1",
"SQL_MCP_DB_PORT": "3306",
"SQL_MCP_DB_USER": "root",
"SQL_MCP_DB_PASSWORD": "your_password",
"SQL_MCP_DB_NAME": "your_database",
"SQL_MCP_LOG_LEVEL": "warn"
}
}
}
}
从源码运行 (供开发者):
如果您想使用开发中的版本,可以配置从项目目录启动。
{
"mcpServers": {
"sql-mcp-dev": {
"command": "node",
"args": [
"C:/path/to/your/sql-mcp/dist/cli.js",
"--transport", "stdio"
],
"env": {
"SQL_MCP_DB_HOST": "127.0.0.1"
}
}
}
}
如果您已将 SQL-MCP 作为独立的 HTTP 服务运行,可以在 Cursor 中通过 URL 连接。
{
"mcpServers": {
"sql-mcp-http": {
"url": "http://127.0.0.1:3000/mcp"
}
}
}
SQL-MCP 支持通过命令行参数、环境变量和配置文件进行配置。
配置优先级: 命令行参数 > 环境变量 > 配置文件。
以下为常用的命令行参数:
所有配置项都可以通过前缀为 SQL_MCP_ 的环境变量进行设置。例如, --host 对应的环境变量为 SQL_MCP_DB_HOST。
复制 ENV.example 文件为 .env 并填入您的数据库连接信息,是快速开始的好方法。
更多配置细节请参阅
src/core/config/loader.ts。
.
├── src/
│ ├── cli/ # 命令行接口 (CLI) 相关逻辑
│ ├── connectors/ # 数据库连接器 (目前为 MySQL)
│ ├── core/ # 核心业务逻辑,包括配置加载和日志
│ ├── mcp/ # MCP 协议实现和处理器
│ ├── middleware/ # Express 中间件 (认证、日志、限流等)
│ ├── services/ # 核心服务 (元数据、查询、缓存等)
│ ├── types/ # TypeScript 类型定义
│ ├── utils/ # 通用工具函数
│ ├── cli.ts # CLI 入口文件
│ └── index.ts # HTTP 服务入口文件
├── Dockerfile # 用于构建 Docker 镜像
├── package.json # 项目依赖和脚本
└── tsconfig.json # TypeScript 配置文件
我们非常欢迎社区通过 Pull Request 或 Issues 为项目做出贡献。在提交代码前,请确保您的代码通过了 lint 和 test 检查。
# 代码风格检查
npm run lint
# 运行单元测试
npm run test
本项目基于 MIT 许可开源。
MySQL-backed Model Context Protocol (MCP) server for database metadata, sampling and read-only queries.
{ "mcpServers": { "polarisxb-sql-mcp": { "command": "npx", "args": [ "-y", "@polarisxb/[email protected]" ] } }}เครื่องมือ
ยังไม่มีรายการเครื่องมือ เซิร์ฟเวอร์แบบรีโมตจะได้รายการหลังการตรวจสอบสถานะครั้งแรก
FAQ
คัดลอกคอนฟิก stdio สำหรับ Cursor, Claude Desktop, Claude Code หรือ VS Code ได้ในหน้านี้ คอนฟิกนี้ใช้การติดตั้งของผู้เผยแพร่ ไม่ใช่พร็อกซีของ PlugMCP
ระเบียนนี้ไม่ได้ระบุตัวแปรสภาพแวดล้อมที่จำเป็น
@polarisxb/sql ทำงานแบบโลคัลผ่าน stdio
ตรวจสอบล่าสุดเมื่อ 2026-11-15 MySQL-backed Model Context Protocol (MCP) server for database metadata, sampling and read-only queries.