what is MCP-Server?
MCP-Server is a project that provides a REST API interface for managing SkySQL databases, enabling seamless integration with GitHub and Smithery.ai.
how to use MCP-Server?
To use MCP-Server, clone the repository, install the dependencies, set up your environment variables, and start the development server. You can then interact with the API endpoints to manage your databases.
key features of MCP-Server?
- Create and manage serverless databases in SkySQL
- RESTful API endpoints for various database operations
- Integration with GitHub for version control
- Deployment support on Smithery.ai
use cases of MCP-Server?
- Managing serverless databases for applications
- Automating database operations through API calls
- Integrating database management with version control systems like GitHub
FAQ from MCP-Server?
- What are the prerequisites for using MCP-Server?
You need Node.js (v14 or higher), npm or yarn, a SkySQL API key, a GitHub account, and a Smithery.ai account.
- How do I deploy my application?
Push your code to GitHub, connect your repository to Smithery.ai, configure your environment variables, and deploy.
- What API endpoints are available?
The available endpoints include creating, listing, getting status, and deleting databases, as well as executing SQL queries.
SkySQL MCP Integration
This project provides a REST API interface for managing SkySQL databases, with integration capabilities for GitHub and Smithery.ai.
Features
- Create and manage serverless databases in SkySQL
- RESTful API endpoints for database operations
- GitHub integration for version control
- Smithery.ai deployment support
Prerequisites
- Node.js (v14 or higher)
- npm or yarn
- SkySQL API key
- GitHub account
- Smithery.ai account
Setup
- Clone the repository:
git clone <your-repo-url>
cd skysql-mcp
- Install dependencies:
npm install
- Create a
.env
file with your credentials:
SKYSQL_API_KEY=your_api_key
SKYSQL_HOST=your_host
SKYSQL_USER=your_user
SKYSQL_PASSWORD=your_password
SKYSQL_DATABASE=your_database
- Start the development server:
npm run dev
API Endpoints
POST /api/databases
- Create a new databaseGET /api/databases
- List all databasesGET /api/databases/:id
- Get database statusDELETE /api/databases/:id
- Delete a databasePOST /api/query
- Execute SQL queriesGET /health
- Health check endpoint
Deployment
This project is configured for deployment on Smithery.ai. Follow these steps:
- Push your code to GitHub
- Connect your GitHub repository to Smithery.ai
- Configure your environment variables in Smithery.ai
- Deploy your application
License
MIT