Mysql Read Only

🚀 MCP Server: MySQL Implementation Guide

This guide provides a comprehensive walk - through on installing, configuring, testing, and troubleshooting the MCP Server with MySQL. It also includes instructions for contributing to the project.

📦 Installation

Install using Smithery

smithery install @benborla/mcp-server-mysql

Install using MCP Get

mcp-get install @benborla/mcp-server-mysql

🛠️ Configuration

You can set environment variables in the following ways according to the configuration options provided in the documentation:

Set the PATH environment variable (optional)

export PATH="/path/to/node/bin:$PATH"

Configuration example

{
  "env": {
    "NODE_OPTIONS": "--loader ts-node/index",
    "PATH": "/path/to/node/bin:/usr/bin:/bin"
  }
}

💻 Usage Examples

Database Preparation

1. Create a test user and database

CREATE USER 'mcp_test'@'localhost' IDENTIFIED BY 'mcp_test_password';
GRANT ALL PRIVILEGES ON mcp_test.* TO 'mcp_test'@'localhost';
FLUSH PRIVILEGES;

2. Run the database script

pnpm run setup:test:db

3. Create a test environment file Create a .env.test file in the project root directory:

MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=mcp_test
MYSQL_PASS=mcp_test_password
MYSQL_DB=mcp_test

Update package.json

Add the following scripts to package.json:

{
  "scripts": {
    "setup:test:db": "ts-node scripts/setup-test-db.ts",
    "pretest": "pnpm run setup:test:db",
    "test": "vitest run",
    "test:watch": "vitest",
    "test:coverage": "vitest run --coverage"
  }
}

Execute Tests

# Initialize the test environment
pnpm run setup:test:db

# Run all tests
pnpm test

🔧 Troubleshooting

Diagnose using Smithery

smithery status @benborla/mcp-server-mysql

smithery diagnose @benborla/mcp-server-mysql

smithery logs @benborla/mcp-server-mysql

Common Issues

1. Connection Issues
   • Confirm the running status of the MySQL server.
   • Check user permission settings.
2. Performance Issues
   • Adjust database configuration parameters.
   • Use more efficient data query methods.
3. Version Compatibility
   • Ensure that the versions of Node.js and related tools are consistent with the project requirements.

🤝 Contribution Guide

Access the Code Repository

git clone https://github.com/yourusername/mcp-server-mysql.git

Set up the Development Environment

1. Clone the repository:

git clone https://github.com/yourusername/mcp-server-mysql.git
cd mcp-server-mysql

2. Install dependencies:

pnpm install

3. Start the development server:

pnpm dev

📚 Documentation Reference

• Official Documentation: MCP Server Documentation
• Community Support: GitHub Repository

By following the steps above, you can easily complete the installation, configuration, and testing of the MCP Server. If you have any questions, please refer to the official documentation or contact the community for help.