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 许可证。