-
Notifications
You must be signed in to change notification settings - Fork 2
Installation
Value Proposition Establish a robust foundation for enterprise AI integrations. Deploy securely across any environment with flexible installation options, distributed rate limiting, and strict operational boundaries.
Deploy with unprecedented speed and scale, laying a resilient foundation for your AI-driven database operations.
- Current Node.js LTS version - Required to run the MCP server and Inspector smoothly.
- A modern MySQL release - Required for database connections. A recent major release is required for native vector embeddings.
- Redis (Optional) - Required for distributed rate limiting.
- pnpm - Package manager
Note: Connection configuration is supported both via the CLI flag (
--mysql) and Environment Variables.
# Run directly without installation
npx -y @neverinfamous/mysql-mcp --transport stdio --mysql mysql://user:password@localhost:3306/database
# Clone the repository
git clone https://github.com/neverinfamous/mysql-mcp.git
# Navigate to directory
cd mysql-mcp
# Install dependencies
pnpm install
# Build the project
pnpm run build
# Run the server
node dist/cli.js --transport stdio --mysql mysql://user:password@localhost:3306/databasedocker run -i --rm \
-e MYSQL_HOST=host.docker.internal \
-e MYSQL_USER=user \
-e MYSQL_PASSWORD=password \
-e MYSQL_DATABASE=database \
writenotenow/mysql-mcp:latest \
--transport stdioRun docker compose up -d from the repository root to spin up a minimal mysql-mcp stack, which does not include pre-loaded Grafana dashboards; you must build your own. For the Datadog test ecosystem and pre-loaded Grafana dashboards, deploy from the test-server/infrastructure directory.
Note
The Docker image uses the writenotenow namespace, whereas the GitHub repo and NPM package use neverinfamous.
For Docker setup details, see the Docker Hub page.
Test the server responds to MCP initialization:
Using NPX (npx -y @neverinfamous/mysql-mcp):
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"<protocol-version>","capabilities":{},"clientInfo":{"name":"test","version":"<client-version>"}}}' | npx -y @neverinfamous/mysql-mcp --transport stdio --mysql mysql://user:password@localhost:3306/databaseLocal Installation (node dist/cli.js):
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"<protocol-version>","capabilities":{},"clientInfo":{"name":"test","version":"<client-version>"}}}' | node dist/cli.js --transport stdio --mysql mysql://user:password@localhost:3306/database- Configuration - Configure MCP clients and environment variables
- Tools - Complete tool list
- Tool Filtering - Reduce tool count for IDE limits
- OAuth - Configure OAuth authentication
- Performance Tuning - Tune connection pooling and metadata caching
Value Proposition Enforce strict execution boundaries and maximize LLM context efficiency for secure, autonomous database interactions. Read the full value proposition
- Installation
- Configuration
- Architecture
- HTTP Transport
- Tool Filtering
- Code Mode
- Tools
- Prompts
- Resources
- Observability & Telemetry