F4ww4z/mcp MySQL Server

1# @f4ww4z/mcp-mysql-server
2[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/f4ww4z/mcp-mysql-server)](https://archestra.ai/mcp-catalog/f4ww4z__mcp-mysql-server)
3[![smithery badge](https://smithery.ai/badge/@f4ww4z/mcp-mysql-server)](https://smithery.ai/server/@f4ww4z/mcp-mysql-server)
4 
5A Model Context Protocol server that provides MySQL database operations. This server enables AI models to interact with MySQL databases through a standardized interface.
6 
7<a href="https://glama.ai/mcp/servers/qma33al6ie"><img width="380" height="200" src="https://glama.ai/mcp/servers/qma33al6ie/badge" alt="mcp-mysql-server MCP server" /></a>
8 
9## Installation
10 
11### Installing via Smithery
12 
13To install MySQL Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@f4ww4z/mcp-mysql-server):
14 
15```bash
16npx -y @smithery/cli install @f4ww4z/mcp-mysql-server --client claude
17```
18 
19### Manual Installation
20```bash
21npx @f4ww4z/mcp-mysql-server
22```
23 
24## Configuration
25 
26The server requires the following environment variables to be set in your MCP settings configuration file:
27 
28> recommended use
29 
30```json
31{
32  "mcpServers": {
33    "mysql": {
34      "command": "npx",
35      "args": ["-y", "@f4ww4z/mcp-mysql-server", "mysql://user:password@localhost:port/database"],
36    }
37  }
38}
39```
40 
41```json
42{
43  "mcpServers": {
44    "mysql": {
45      "command": "npx",
46      "args": ["-y", "@f4ww4z/mcp-mysql-server"],
47      "env": {
48        "MYSQL_HOST": "your_host",
49        "MYSQL_USER": "your_user",
50        "MYSQL_PASSWORD": "your_password",
51        "MYSQL_DATABASE": "your_database"
52      }
53    }
54  }
55}
56```
57## codex 
58 
59### mac
60 
61在 `~/.codex/config.toml`
62 
63```toml
64[mcp_servers.mcp-mysql-server]
65command = "npx"
66args = [
67  "-y",
68  "@f4ww4z/mcp-mysql-server",
69  "mysql://user:password@127.0.0.1:3306/database"
70]
71```
72 
73### windows
74 
75在 `%USERPROFILE%\.codex\config.toml`
76 
77```toml
78[mcp_servers.mcp-mysql-server]
79command = "npx"
80args = [
81  "-y",
82  "@f4ww4z/mcp-mysql-server",
83  "mysql://user:password@127.0.0.1:3306/database"
84]
85```
86 
87 
88## Running evals
89 
90The evals package loads an mcp client that then runs the index.ts file, so there is no need to rebuild between tests. You can load environment variables by prefixing the npx command. Full documentation can be found [here](https://www.mcpevals.io/docs).
91 
92```bash
93OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/index.ts
94```
95## Available Tools
96 
97### 1. connect_db
98Establish connection to MySQL database using provided credentials.
99 
100```typescript
101use_mcp_tool({
102  server_name: "mysql",
103  tool_name: "connect_db",
104  arguments: {
105    host: "localhost",
106    user: "your_user",
107    password: "your_password",
108    database: "your_database"
109  }
110});
111```
112 
113### 2. query
114Execute SELECT queries with optional prepared statement parameters.
115 
116```typescript
117use_mcp_tool({
118  server_name: "mysql",
119  tool_name: "query",
120  arguments: {
121    sql: "SELECT * FROM users WHERE id = ?",
122    params: [1]
123  }
124});
125```
126 
127### 3. execute
128Execute INSERT, UPDATE, or DELETE queries with optional prepared statement parameters.
129 
130```typescript
131use_mcp_tool({
132  server_name: "mysql",
133  tool_name: "execute",
134  arguments: {
135    sql: "INSERT INTO users (name, email) VALUES (?, ?)",
136    params: ["John Doe", "john@example.com"]
137  }
138});
139```
140 
141### 4. list_tables
142List all tables in the connected database.
143 
144```typescript
145use_mcp_tool({
146  server_name: "mysql",
147  tool_name: "list_tables",
148  arguments: {}
149});
150```
151 
152### 5. describe_table
153Get the structure of a specific table.
154 
155```typescript
156use_mcp_tool({
157  server_name: "mysql",
158  tool_name: "describe_table",
159  arguments: {
160    table: "users"
161  }
162});
163```
164 
165## Features
166 
167- Secure connection handling with automatic cleanup
168- Prepared statement support for query parameters
169- Comprehensive error handling and validation
170- TypeScript support
171- Automatic connection management
172 
173## Security
174 
175- Uses prepared statements to prevent SQL injection
176- Supports secure password handling through environment variables
177- Validates queries before execution
178- Automatically closes connections when done
179 
180## Error Handling
181 
182The server provides detailed error messages for common issues:
183- Connection failures
184- Invalid queries
185- Missing parameters
186- Database errors
187 
188## Contributing
189 
190Contributions are welcome! Please feel free to submit a Pull Request to https://github.com/f4ww4z/mcp-mysql-server
191 
192## License
193 
194MIT
195