Skip to content

Releases: polarisxb/sql-mcp

v1.4.0

Choose a tag to compare

@polarisxb polarisxb released this 13 Aug 07:56

v1.4.0

本次为“可验证的智能建议 + 一键自检”版本,围绕 Cursor 开发体验闭环升级。

✨ 新增

  • 顾问框架(Advisor)
    • PlanAnalyzer:解析 EXPLAIN(JSON) → summary/risks/signals
    • IndexAdvisor:计划 + SQL 形态 → 分级索引建议(支持别名解析)
    • QueryRewriter:只读改写(避免 SELECT*、Keyset 模板、前导 LIKE 告警、SARGable 示例)
  • 新工具
    • indexAdvisor(sql):专用索引建议(text + advisor-evidence.json)
    • rewriteQuery(sql):专用查询改写(text + advisor-evidence.json)
    • doctor():连通/只读/EXPLAIN 自检 + 重复/前缀冗余索引扫描;CLI 支持 --doctor

🔄 改进

  • optimizeQuery:统一证据 JSON(plan/analysis/suggestions/rewrites),并补充重复/冗余索引建议
  • README:新增新工具说明与示例;强调返回规范为 text + JSON 证据

🧪 测试

  • 新增 Advisor/导师工具单测与服务注册校验
  • 新增重复/冗余索引建议测试
  • 新增 QueryRewriter 场景测试(SELECT*、OFFSET、前导 LIKE、函数包列)

如对你有帮助,欢迎 Star、反馈 Issue 或提交 PR 🙌

Full Changelog: v1.3.0...v1.4.0

v1.3.0

Choose a tag to compare

@polarisxb polarisxb released this 12 Aug 10:20

v1.3.0

本次更新带来更好的一键体验与协议兼容:

- 新增
  - CLI 支持 `--dsn`(`mysql://user:pass@host:port/dbname`),显式参数可覆盖 DSN。
  - Demo 环境:docker compose 一键启动,自动初始化电商示例库(含健康检查与依赖)。
  - README 新增 MCP Inspector 调试指南(HTTP 与 stdio)。

- 变更
  - 返回内容改为 MCP 标准:`resource`(`application/json`)替代非标准 `json`。
  - 模糊搜索体验优化:无 `%/_` 时默认按“子串匹配”,保留 LIKE 语义支持。
  - 标识符校验更友好:自动 trim,空值报错更清晰。
  - 文档增强:新增 Demo、DSN、Inspector、排错说明。

- 修复
  - 避免 MySQL 未就绪即连接导致失败(健康检查 + `service_healthy`)。

感谢试用,欢迎提 Issue/PR。如果对你有帮助,Star 一下支持我们!

Full Changelog: v1.2.1...v1.3.0

v1.2.1

Choose a tag to compare

@polarisxb polarisxb released this 11 Aug 13:04

v1.2.1 - 文档更新

本次发布为文档更新版本,主要对 README.md 进行了全面的重构和优化,以提供更清晰、更友好的用户指引。本次更新不包含任何功能性代码变更。

📝 主要文档更新

  • 全面的 README 重构: 对 README.md 进行了彻底的重写,优化了整体结构、精炼了语言描述,使其更具可读性和清晰度。
  • 新增 Cursor 集成指南: 添加了全新的 "Cursor 集成" 章节,提供了详细的 mcp.json 配置示例,包括 stdiohttp 两种模式,方便用户快速上手。
  • 完善的配置说明: 重新加入了内容详尽的“环境变量对照表”,并对表格进行了分类和美化,让配置过程更加直观透明。
  • 精准的项目描述: 优化了项目的核心描述,更准确地定义了 SQL-MCP 作为连接 LLM 与数据库的桥梁的角色。

Full Changelog: v1.2.0...v1.2.1

v1.2.0

Choose a tag to compare

@polarisxb polarisxb released this 11 Aug 04:29

SQL-MCP v1.2.0 — Stdio 体验升级

  • 扩展 stdio 使用场景:更稳、更省心的输出;更好用的检索与维护工具
  • 保持向后兼容,无破坏性改动

新增

  • 执行查询
    • executeQuery 支持分页参数:limit/offset
    • 同时返回 JSON 元信息:limit/offset/nextOffset/hasMore/durationMs/columns/data
  • 工具
    • searchTables(pattern):按名称模式检索表
    • searchColumns(pattern):按列名/类型/备注检索
    • refreshCache(scope=all|table):刷新元数据缓存
  • 启动优化
    • 冷启动预热:后台预取表清单(cache.prewarmOnStart,默认开启)

Stdio 安全与输出控制

  • 新旗标
    • --stdio-safe:压低日志、紧凑输出、合理上限
    • --compact:紧凑表格输出,减少体积
    • --json-only:仅输出 JSON,便于程序/AI 消费
  • 新配置
    • security.queryMaxRows(默认 200):限制 executeQuery 单页行数
    • SQL_MCP_CACHE_PREWARM_ON_START(默认 true):开启预热

使用示例

# 更安全的 stdio 预设
sql-mcp --transport stdio --stdio-safe

# 仅输出 JSON
sql-mcp --transport stdio --json-only

# 分页查询(在 MCP 客户端中调用)
executeQuery { sql: "SELECT * FROM users ORDER BY id", limit: 100, offset: 0 }
# 下一页:offset 使用上次的 nextOffset

升级说明

  • 默认行为更“保守”(查询结果分页、可选紧凑/JSON 输出),如需与旧体验一致,可调大 security.queryMaxRows,或关闭相关开关
  • 无破坏性改动;现有集成无需修改即可使用新增能力

变更对照

  • 详见仓库 CHANGELOG.md 的 1.2.0 条目

Full Changelog: v1.2.0...v1.2.0