KWDB MCP Server

KWDB MCP Server

site icon
2025.04.17 1
Go数据库管理商业智能数据库
KWDB MCP Server 是一个基于 MCP(Model Context Protocol)协议的服务器实现,提供了一套工具和资源,用于通过 MCP 协议与 KWDB 数据库交互并提供商业智能功能。该服务器支持数据的读取、写入、查询、修改以及执行 DDL 操作。
View on GitHub

Overview

产品定位

KWDB MCP Server 是一个基于 MCP 协议的数据库服务工具,旨在通过标准化的协议提供数据库操作和商业智能功能。

核心功能

  • 读取操作:执行 SELECT, SHOW, EXPLAIN 等只读查询。
  • 写入操作:执行 INSERT, UPDATE, DELETE 以及 CREATE, DROP, ALTER 等 DDL 操作。
  • 数据库信息:获取数据库的元数据,包括表及其结构信息。
  • 语法指南:通过 Prompts 提供 KWDB 的全面语法指南。
  • 标准 API 响应:所有 API 响应均采用一致的 JSON 结构。
  • 自动 LIMIT:为没有 LIMIT 子句的 SELECT 查询自动添加 LIMIT 20 以防止返回过大结果集。

适用场景

  • 数据库管理和操作
  • 商业智能分析
  • 数据迁移和备份
  • 性能调优和故障排查

MCP 工具列表

  • read-query:执行只读查询,如 SELECT, SHOW, EXPLAIN
  • write-query:执行数据修改和 DDL 操作,如 INSERT, UPDATE, DELETE, CREATE, ALTER, DROP

常见问题解答

  • 如何添加 MCP Prompts:创建 Markdown 文件并更新 pkg/prompts/prompts.go
  • 如何修改 MCP Prompts:编辑对应的 Markdown 文件并重新构建应用。

使用教程

使用依赖

  • 安装 Go 1.23 或更高版本。
  • 下载并安装 PostgreSQL 驱动 lib/pq
  • 安装并启动 KWDB,配置认证方法并创建数据库。

安装教程

  1. 克隆仓库: shell git clone https://gitee.com/kwdb/kwdb-mcp-server cd kwdb-mcp-server
  2. 安装依赖: shell make deps
  3. 构建应用: shell make build

调试方式

  • StdIO 模式shell ./bin/kwdb-mcp-server "postgresql://<username>:<password>@<hostname>:<port>/<database_name>?sslmode=disable"
  • SSE 模式shell ./bin/kwdb-mcp-server -t sse -addr ":8080" -base-url "http://localhost:8080" "postgresql://<username>:<password>@<hostname>:<port>/<database_name>?sslmode=disable"

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。