repository·main·Indexed 41 days ago
https://github.com/f4ww4z/mcp-mysql-serverA Model Context Protocol (MCP) server version 0.1.0 that enables AI models to interact with MySQL databases. It provides tools for connecting to databases, executing SELECT queries via `query`, performing data modifications via `execute`, and inspecting schemas using `list_tables` and `describe_table`.
You can install the MySQL MCP server using Smithery for automatic Claude Desktop configuration, or via manual installation using npx.
### Installing via Smithery
```bash
npx -y @smithery/cli install @f4ww4z/mcp-mysql-server --client claudenpx @f4ww4z/mcp-mysql-serverYou can run evaluations using mcp-eval. You can load environment variables by prefixing the command. This uses the index.ts file from the source to run tests against the server.
OPENAI_API_KEY=your-key npx mcp-eval src/evals/evals.ts src/index.tsTo use this server with Codex, add the configuration to your config.toml file.
~/.codex/config.toml%USERPROFILE%\.codex\config.toml[mcp_servers.mcp-mysql-server]
command = "npx"
args = [
"-y",
"@f4ww4z/mcp-mysql-server",
"mysql://user:password@127.0.0.1:3306/database"
]The server can be configured using either a connection string passed as an argument or via environment variables.
Option 1: Connection String (Recommended)
Pass the connection URI directly in the args array.
Option 2: Environment Variables Set the following environment variables in your MCP settings configuration:
MYSQL_HOSTMYSQL_USERMYSQL_PASSWORDMYSQL_DATABASE// Option 1: Connection String
{
"mcpServers": {
"mysql": {
"command": "npx",
"args": ["-y", "@f4ww4z/mcp-mysql-server", "mysql://user:password@localhost:port/database"]
}
}
}
// Option 2: Environment Variables
{
"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"
}
}
}
}The MySQL MCP server can be configured using a MySQL connection URL passed as a command-line argument or via specific environment variables. If no configuration is provided, the server will exit with an error.
Pass a mysql:// URL as the first command-line argument:
mysql://user:password@host:port/database
If no command-line argument is provided, the server falls back to these environment variables:
MYSQL_HOSTMYSQL_USERMYSQL_PASSWORDMYSQL_DATABASEMYSQL_PORT (defaults to 3306 if not set)connect_db toolYou can also change or establish a connection dynamically during a session using the connect_db tool, which accepts either a url or individual connection parameters (host, user, password, database, port).
# Example using command line argument
node index.js mysql://root:secret@localhost:3306/my_database
# Example using environment variables
export MYSQL_HOST=localhost
export MYSQL_USER=root
export MYSQL_PASSWORD=secret
export MYSQL_DATABASE=my_database
node index.jsEstablishes a connection to the MySQL database using the provided credentials.
use_mcp_tool({
server_name: "mysql",
tool_name: "connect_db",
arguments: {
host: "localhost",
user: "your_user",
password: "your_password",
database: "your_database"
}
});Retrieves the structure (schema) of a specific table.
use_mcp_tool({
server_name: "mysql",
tool_name: "describe_table",
arguments: {
table: "users"
}
});Lists all tables available in the currently connected database.
use_mcp_tool({
server_name: "mysql",
tool_name: "list_tables",
arguments: {}
});Executes data-modifying queries such as INSERT, UPDATE, or DELETE. Supports prepared statement parameters.
use_mcp_tool({
server_name: "mysql",
tool_name: "execute",
arguments: {
sql: "INSERT INTO users (name, email) VALUES (?, ?)",
params: ["John Doe", "john@example.com"]
}
});Executes SELECT queries. Supports prepared statement parameters to prevent SQL injection.
use_mcp_tool({
server_name: "mysql",
tool_name: "query",
arguments: {
sql: "SELECT * FROM users WHERE id = ?",
params: [1]
}
});To explore the database schema, use these two tools:
list_tables: Returns a JSON array of all table names in the current database.describe_table: Returns the column structure (field names, types, etc.) for a specific table.describe_table Arguments:
table (string, required): The name of the table to inspect.// Example: List all tables
{
"name": "list_tables",
"arguments": {}
}
// Example: Describe the 'users' table
{
"name": "describe_table",
"arguments": {
"table": "users"
}
}The execute tool is used for queries that modify data, such as INSERT, UPDATE, or DELETE. It will throw an error if you attempt to use a SELECT statement with this tool.
Arguments:
sql (string, required): The SQL query.params (array, optional): An array of values to be used as query parameters.{
"name": "execute",
"arguments": {
"sql": "UPDATE users SET email = ? WHERE id = ?",
"params": ["newemail@example.com", 1]
}
}