Skysql MCP Integration

🚀 SkySQL MCP 集成

該項目提供了一個用於管理 SkySQL 數據庫的 REST API 接口，同時集成了 GitHub 和 Smithery.ai 的功能，能有效助力數據庫的管理與版本控制。

🚀 快速開始

先決條件

在開始之前，你需要準備以下環境：

• Node.js (v14 或更高版本)
• npm 或 yarn
• SkySQL API 密鑰
• GitHub 賬戶
• Smithery.ai 賬戶

項目搭建

按照以下步驟搭建項目：

1. 克隆倉庫：

git clone <your-repo-url>
cd skysql-mcp

2. 安裝依賴項：

npm install

3. 創建一個 .env 文件並添加你的憑證：

SKYSQL_API_KEY=your_api_key
SKYSQL_HOST=your_host
SKYSQL_USER=your_user
SKYSQL_PASSWORD=your_password
SKYSQL_DATABASE=your_database

4. 啟動開發服務器：

npm run dev

部署

該項目已配置為在 Smithery.ai 上部署，你可以按照以下步驟操作：

1. 將代碼推送到 GitHub。
2. 將你的 GitHub 倉庫連接到 Smithery.ai。
3. 在 Smithery.ai 中配置環境變量。
4. 部署應用程序。

✨ 主要特性

• 創建和管理無服務器數據庫。
• 提供 RESTful API 端點用於數據庫操作。
• 集成 GitHub 用於版本控制。
• 支持 Smithery.ai 部署。

💻 使用示例

基礎用法

以下是一些常用 API 端點的使用示例：

# 創建新數據庫
curl -X POST http://localhost:3000/api/databases

# 列出所有數據庫
curl -X GET http://localhost:3000/api/databases

# 獲取數據庫狀態
curl -X GET http://localhost:3000/api/databases/1

# 刪除數據庫
curl -X DELETE http://localhost:3000/api/databases/1

# 執行 SQL 查詢
curl -X POST -H "Content-Type: application/json" -d '{"query": "SELECT * FROM users"}' http://localhost:3000/api/query

# 健康檢查端點
curl -X GET http://localhost:3000/health

📚 詳細文檔

API 端點

• POST /api/databases - 創建新數據庫
• GET /api/databases - 列出所有數據庫
• GET /api/databases/:id - 獲取數據庫狀態
• DELETE /api/databases/:id - 刪除數據庫
• POST /api/query - 執行 SQL 查詢
• GET /health - 健康檢查端點

📄 許可證

本項目採用 MIT 許可證。