https://github.com/f4ww4z/mcp-mysql-server
A Model Context Protocol server for MySQL database operations
https://github.com/f4ww4z/mcp-mysql-server
Last synced: 25 days ago
JSON representation
A Model Context Protocol server for MySQL database operations
- Host: GitHub
- URL: https://github.com/f4ww4z/mcp-mysql-server
- Owner: f4ww4z
- License: mit
- Created: 2024-12-13T09:39:28.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T14:59:15.000Z (about 1 month ago)
- Last Synced: 2025-03-07T15:38:12.500Z (about 1 month ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-list - f4ww4z/mcp-mysql-server - mysql-server?style=social)](https://github.com/f4ww4z/mcp-mysql-server): Offers secure MySQL database interaction. (Uncategorized / Uncategorized)
- awesome-mcp-servers - f4ww4z/mcp-mysql-server - Node.js-based MySQL database integration that provides secure MySQL database operations (Legend / 🗄️ <a name="databases"></a>Databases)
- awesome-mcp-servers - f4ww4z/mcp-mysql-server - Node.js-based MySQL database integration that provides secure MySQL database operations (Legend / 🗄️ <a name="databases"></a>Databases)
- awesome-mcp-servers - MCP MySQL Server - A Model Context Protocol server for MySQL database operations (Table of Contents / Databases)
- awesome-mcp-servers - MCP MySQL Server - A Model Context Protocol server for MySQL database operations (Table of Contents / Databases)
README
# @f4ww4z/mcp-mysql-server
[](https://smithery.ai/server/@f4ww4z/mcp-mysql-server)
A Model Context Protocol server that provides MySQL database operations. This server enables AI models to interact with MySQL databases through a standardized interface.
## Installation
### Installing via Smithery
To install MySQL Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@f4ww4z/mcp-mysql-server):
```bash
npx -y @smithery/cli install @f4ww4z/mcp-mysql-server --client claude
```
### Manual Installation
```bash
npx @f4ww4z/mcp-mysql-server
```
## Configuration
The server requires the following environment variables to be set in your MCP settings configuration file:
```json
{
"mcpServers": {
"mysql": {
"command": "npx",
"args": ["-y", "@f4ww4z/mcp-mysql-server"],
"env": {
"MYSQL_HOST": "your_host",
"MYSQL_USER": "your_user",
"MYSQL_PASSWORD": "your_password",
"MYSQL_DATABASE": "your_database"
}
}
}
}
```
## Available Tools
### 1. connect_db
Establish connection to MySQL database using provided credentials.
```typescript
use_mcp_tool({
server_name: "mysql",
tool_name: "connect_db",
arguments: {
host: "localhost",
user: "your_user",
password: "your_password",
database: "your_database"
}
});
```
### 2. query
Execute SELECT queries with optional prepared statement parameters.
```typescript
use_mcp_tool({
server_name: "mysql",
tool_name: "query",
arguments: {
sql: "SELECT * FROM users WHERE id = ?",
params: [1]
}
});
```
### 3. execute
Execute INSERT, UPDATE, or DELETE queries with optional prepared statement parameters.
```typescript
use_mcp_tool({
server_name: "mysql",
tool_name: "execute",
arguments: {
sql: "INSERT INTO users (name, email) VALUES (?, ?)",
params: ["John Doe", "[email protected]"]
}
});
```
### 4. list_tables
List all tables in the connected database.
```typescript
use_mcp_tool({
server_name: "mysql",
tool_name: "list_tables",
arguments: {}
});
```
### 5. describe_table
Get the structure of a specific table.
```typescript
use_mcp_tool({
server_name: "mysql",
tool_name: "describe_table",
arguments: {
table: "users"
}
});
```
## Features
- Secure connection handling with automatic cleanup
- Prepared statement support for query parameters
- Comprehensive error handling and validation
- TypeScript support
- Automatic connection management
## Security
- Uses prepared statements to prevent SQL injection
- Supports secure password handling through environment variables
- Validates queries before execution
- Automatically closes connections when done
## Error Handling
The server provides detailed error messages for common issues:
- Connection failures
- Invalid queries
- Missing parameters
- Database errors
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request to https://github.com/f4ww4z/mcp-mysql-server
## License
MIT