Database MCP

🚀 數據庫 MCP 服務

數據庫 MCP 服務支持多種數據庫類型，藉助 GORM 提供數據庫功能，通過 Meteor 控制協議 (MCP) 實現高效管理。

🚀 快速開始

本服務支持多種數據庫類型，可通過配置文件、命令行參數或環境變量進行配置，集成了 MCP 協議並支持 GORM ORM，為你提供便捷的數據庫操作體驗。

✨ 主要特性

• 支持多種數據庫類型：
  • MySQL
  • PostgreSQL
  • SQLite
  • SQL Server
  • ClickHouse
• 靈活的配置方式：
  • 配置文件（YAML）
  • 命令行參數
  • 環境變量
• MCP 協議集成：無縫對接 MCP 協議，實現高效控制。
• GORM ORM 支持：藉助 GORM ORM 簡化數據庫操作。

📦 安裝指南

1. 克隆倉庫。
2. 安裝依賴項：

   go mod tidy
   

📚 詳細文檔

配置說明

配置文件（config.yaml）

創建一個 config.yaml 文件，結構如下：

database:
  type: "mysql"  # mysql, postgres, sqlite, sqlserver, clickhouse
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  database: "mydb"
  ssl_mode: "disable"  # for postgres
  file: "database.db"  # for sqlite

命令行參數

可以通過命令行覆蓋配置文件的設置：

./database-mcp --config=config.yaml \
  --db-type=mysql \
  --db-host=localhost \
  --db-port=3306 \
  --db-user=root \
  --db-pass=password \
  --db-name=mydb \
  --db-ssl-mode=disable \
  --db-file=database.db

可用的命令行參數包括：

使用說明

1. 啟動服務：

   ./database-mcp --db-type=mysql --db-host=127.0.0.1 --db-port=3306 --db-user=dbuser --db-pass=passwd --db-name=dbname --db-ssl-mode=disable --mode=http
   

2. 服務功能：
   • 加載配置文件和/或命令行參數。
   • 初始化數據庫連接。
   • 啟動 MCP 服務器。
   • 註冊可用工具和資源。

MCP 配置

要使用 MCP 服務，請在你的 MCP 客戶端中配置 MCP 端點：

http://127.0.0.1:8080/sse

這將使你的 MCP 客戶端連接到本地運行的服務，端口為 8080。

MCP 工具

該服務提供以下 MCP 工具：

1. get_tables：獲取數據庫中的所有表
   • 返回值：包含表名和備註的列表。
2. get_table_detail：獲取特定表的詳細信息
   • 參數：
     • table_name：要獲取詳細信息的表名稱。
   • 返回值：包括表名稱、備註、列信息（字段名、類型、備註、是否為空、默認值）等信息。
3. execute_sql：執行 SQL 查詢
   • 參數：
     • query：要執行的 SQL 查詢語句。
   • 返回值：
     • 對於 SELECT 查詢：結果數據數組。
     • 對於其他查詢（如 INSERT, UPDATE, DELETE）：受影響的行數。

📄 許可證

MIT License