MCP Server Local WP
🎯 What if your AI assistant could actually SEE your WordPress database?
A Model Context Protocol (MCP) server that gives AI assistants like Claude and Cursor direct, read-only access to your Local by Flywheel WordPress database. No more guessing table structures. No more writing SQL queries blind. Your AI can now understand your actual data.
Upgrading to 2.0
Version 2.0 requires Node.js 24 or newer and uses MCP SDK v2. Existing tool names and site selectors remain available. Query results are now { "rows": [...] }; schema listing returns { "tables": [...], "hasMore": false, "nextAfter": null } with bounded pages of table names. Successful tools return matching structured and JSON-text results, and failures set isError: true.
Database and Local configuration are resolved lazily, so MCP tool discovery works without a running site. Explicit MYSQL_HOST or MYSQL_SOCKET_PATH selects the manual connection. Keep stdin open until all tool responses arrive; EOF closes the session. The parent watchdog also cleans up abandoned stdio servers.
🤔 What's an MCP Server?
Think of MCP (Model Context Protocol) as a secure bridge between AI assistants and your development tools. Instead of copying and pasting database schemas or query results, MCP servers let AI assistants directly interact with your tools while you maintain complete control.
Without MCP: "Hey AI, I think there's a table called wp_something with a column that might be named user_meta... can you write a query?"
With MCP: "Hey AI, check what's in my database and write the exact query I need."
💡 The WordPress Developer's Dilemma
Picture this: You're debugging a LearnDash integration issue. Quiz results aren't syncing properly. You fire up Cursor to help diagnose the problem, but without database access, even the most advanced AI is just making educated guesses about your table structures.
The Real-World Impact
Here's an actual support ticket we were working on. The task was simple: fetch quiz activity data from LearnDash tables.
❌ Before MCP Server (AI Flying Blind):
The AI tried its best, suggesting this query:
$quiz_activities = $wpdb->get_results(
$wpdb->prepare(
'SELECT post_id, activity_meta FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . '
WHERE user_id=%d AND activity_type=%s AND activity_status=1 AND activity_completed IS NOT NULL',
$user_id,
'quiz'
),
ARRAY_A
);
Problem? The activity_meta column doesn't exist! LearnDash stores metadata in a completely separate table with a different structure. Without database access, the AI made reasonable but incorrect assumptions. You'd spend the next 20 minutes manually correcting table names, discovering relationships, and rewriting the query.
✅ After MCP Server (AI With X-Ray Vision):
With database access, the AI immediately saw the actual table structure and wrote:
$quiz_activities = $wpdb->get_results(
$wpdb->prepare(
'SELECT ua.post_id, ua.activity_id, uam.activity_meta_key, uam.activity_meta_value
FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' ua
LEFT JOIN ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity_meta' ) ) . ' uam
ON ua.activity_id = uam.activity_id
WHERE ua.user_id=%d AND ua.activity_type=%s AND ua.activity_completed IS NOT NULL
AND uam.activity_meta_key IN (%s, %s, %s)',
$user_id,
'quiz',
'percentage',
'points',
'total_points'
),
ARRAY_A
);
The difference? The AI could see that metadata lives in a separate user_activity_meta table, understood the relationship through activity_id, and knew exactly which meta keys were available. First try. Zero guesswork. Problem solved.
🚀 Why This Changes Everything
When your AI assistant can read your database:
- No more schema guessing - It sees your actual tables and columns
- Accurate JOIN operations - It understands table relationships
- Real data validation - It can verify that data exists before suggesting queries
- Plugin-aware development - It adapts to any plugin's custom tables (WooCommerce, LearnDash, etc.)
- Instant debugging - "Show me all users who haven't completed quiz ID 42" becomes a 5-second task
🔧 The Local by Flywheel Challenge We Solved
When using the original mcp-server-mysql with Local by Flywheel, developers face several challenges:
- Dynamic Paths: Local by Flywheel generates unique identifiers for each site (like
lx97vbzE7) that change when sites are restarted - Socket vs Port Confusion: Local uses both Unix sockets and TCP ports, but the configuration can be tricky
- Hardcoded Configurations: Most setups require manual path updates every time Local restarts
Our Solution
This MCP server automatically detects your active Local by Flywheel MySQL instance by:
- Process Detection: Scans running processes to find active
mysqldinstances - Config Parsing: Extracts MySQL configuration from the active Local site
- Dynamic Connection: Connects using the correct socket path or port automatically
- Fallback Support: Falls back to environment variables for non-Local setups
Multi-Site Support
When you have multiple Local sites, the server uses priority-based site selection to ensure you're always connected to the right database:
Selection Priority
SITE_IDenv var - Direct site ID (highest priority)SITE_NAMEenv var - Human-readable site name lookup- Working directory detection - If your cwd is within a Local site path, that site is used
- Process detection - First running Local mysqld found
- Filesystem fallback - Most recently modified socket
Explicit Site Selection
Specify which site to connect to in your MCP config:
{
"mcpServers": {
"wordpress-dev": {
"command": "npx",
"args": ["-y", "@verygoodplugins/mcp-local-wp@latest"],
"env": {
"SITE_NAME": "dev"
}
}
}
}
Or use the site ID directly:
{
"env": {
"SITE_ID": "lx97vbzE7"
}
}
Working Directory Detection
When using Claude Code or Cursor, the server automatically detects which site you're working in based on your current directory. If you're editing files in /Users/.../Local Sites/dev/app/public/wp-content/plugins/my-plugin/, the server connects to the "dev" site's database automatically.
Verifying Your Connection
Use the mysql_current_site tool to see which site you're connected to:
{
"siteName": "dev",
"siteId": "lx97vbzE7",
"sitePath": "/Users/.../Local Sites/dev",
"domain": "dev.local",
"selectionMethod": "cwd_detection",
}
Use mysql_list_sites to see all available sites and their status.
Tools Available
mysql_query
Execute read-only SQL against your Local WordPress database.
Input fields:
sql(string): Single read-only statement (SELECT, including WITH CTEs, or SHOW/DESCRIBE/EXPLAIN)params((string | number | boolean | null)[]): Optional parameter values for?placeholders
Example Usage:
-- With parameters
SELECT * FROM wp_posts WHERE post_status = ? ORDER BY post_date DESC LIMIT ?;
-- params: ["publish", "5"]
-- Direct queries
SELECT option_name, option_value FROM wp_options WHERE option_name LIKE '%theme%';
SHOW TABLES;
DESCRIBE wp_users;
-- Common table expression (CTE)
WITH published AS (SELECT ID, post_title FROM wp_posts WHERE post_status = ?)
SELECT * FROM published LIMIT 10;
-- params: ["publish"]
mysql_schema
Inspect database schema using INFORMATION_SCHEMA.
- No args: lists up to 100 table names, sorted by their binary name, with
hasMoreandnextAfter - Listing options:
prefix(case-sensitive literal prefix),limit(1–200),after(previous page'snextAfter), andincludeStats(defaults to false) - With
table: returns columns and indexes for that table
When hasMore is true, pass nextAfter as after to fetch the next page, keeping the same prefix. The last page has hasMore: false and nextAfter: null. Listing rows contain only table_name by default; includeStats: true adds engine, estimated row count, data bytes and index bytes. % and _ in a prefix are literal characters. Use table alone for detailed inspection; listing options cannot be combined with it. Each page reflects the current schema, so changes to tables between requests can affect the listing.
Examples:
// First page of table names
{
"tool": "mysql_schema",
"args": {}
}
// Filter to WordPress tables and include statistics
{
"tool": "mysql_schema",
"args": { "prefix": "wp_", "limit": 50, "includeStats": true }
}
// Continue a filtered listing using the previous response's nextAfter
{
"tool": "mysql_schema",
"args": { "prefix": "wp_", "limit": 50, "after": "wp_posts" }
}
// Inspect a specific table
{
"tool": "mysql_schema",
"args": { "table": "wp_posts" }
}
mysql_current_site
Get information about the currently connected Local WordPress site.
Returns the site name, ID, path, domain, socket path, and how the site was selected (env var, cwd detection, or auto-detection).
{
"tool": "mysql_current_site",
"args": {},
}
// Returns:
// {
// "siteName": "dev",
// "siteId": "lx97vbzE7",
// "sitePath": "/Users/.../Local Sites/dev",
// "domain": "dev.local",
// "selectionMethod": "cwd_detection",
// "socketPath": "/Users/.../Local/run/lx97vbzE7/mysql/mysqld.sock"
// }
mysql_list_sites
List all available Local WordPress sites and their running status.
{
"tool": "mysql_list_sites",
"args": {},
}
// Returns:
// {
// "sites": [
// { "id": "lx97vbzE7", "name": "dev", "domain": "dev.local", "running": true },
// { "id": "WP7lolWDi", "name": "staging", "domain": "staging.local", "running": false }
// ],
// "currentSiteId": "lx97vbzE7"
// }
Installation
Prerequisites
- Local by Flywheel installed and running
- An active Local site running
- Node.js 24+
Quick Setup (Recommended)
The easiest way to get started - no installation required:
Cursor IDE Configuration
Add this to your Cursor MCP configuration file (.cursor/mcp.json):
{
"mcpServers": {
"mcp-local-wp": {
"command": "npx",
"args": ["-y", "@verygoodplugins/mcp-local-wp@latest"]
}
}
}
Claude Desktop Configuration
Add this to your Claude Desktop configuration file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\\Claude\\claude_desktop_config.json
{
"mcpServers": {
"mcp-local-wp": {
"command": "npx",
"args": ["-y", "@verygoodplugins/mcp-local-wp@latest"]
}
}
}
Advanced Setup (Local Development)
For customization or local development:
Install from Source
git clone https://github.com/verygoodplugins/mcp-local-wp.git
cd mcp-local-wp
npm install
npm run build
Local Configuration
{
"mcpServers": {
"mcp-local-wp": {
"command": "node",
"args": ["/full/path/to/mcp-local-wp/dist/index.js"]
}
}
}
Custom Environment Variables
For non-Local setups or custom configurations:
{
"mcpServers": {
"mcp-local-wp": {
"command": "npx",
"args": ["-y", "@verygoodplugins/mcp-local-wp@latest"],
"env": {
"MYSQL_DB": "local",
"MYSQL_HOST": "localhost",
"MYSQL_PORT": "3306",
"MYSQL_USER": "root",
"MYSQL_PASS": "root"
}
}
}
}
Site Selection Variables
How It Works with Local by Flywheel
This MCP server was created because connecting to Local by Flywheel MySQL was "kind of difficult to get working" with existing MCP servers. Here's the story of what we solved:
The Original Problem
When we first tried to use mcp-server-mysql with Local by Flywheel, we encountered several issues:
- Dynamic Socket Paths: Local generates paths like
/Users/.../Local/run/lx97vbzE7/mysql/mysqld.sockwherelx97vbzE7changes each time you restart Local - Configuration Complexity: The original server required hardcoded paths that would break every time Local restarted
- Host/Port Confusion: Local's MySQL configuration can be tricky with both socket and TCP connections available
Our Solution Process
We solved this step by step:
1. Process-Based Detection
Instead of guessing paths, we scan for the actual running MySQL process:
ps aux | grep mysqld | grep -v grep
This finds the active MySQL instance and extracts its configuration file path.
2. Dynamic Path Resolution
// From the process args: --defaults-file=/Users/.../Local/run/lx97vbzE7/conf/mysql/my.cnf
// We extract the site directory and build the socket path
const configPath = extractFromProcess();
const siteDir = path.dirname(path.dirname(path.dirname(configPath)));
const socketPath = path.join(siteDir, 'mysql/mysqld.sock');
3. Automatic Configuration
The server automatically configures itself with:
- Correct socket path for the active Local site
- Proper database name (
local) - Default credentials (
root/root) - Fallback to environment variables if needed
Why This Approach Works
✅ Restart Resilient: Works every time you restart Local by Flywheel
✅ Site Switching: Automatically adapts if you switch between Local sites
✅ Zero Maintenance: No need to manually update paths ever again
✅ Error Handling: Provides clear error messages if MySQL isn't running
Local Directory Structure We Handle
~/Library/Application Support/Local/run/
├── lx97vbzE7/ # Dynamic site ID (changes on restart)
│ ├── conf/mysql/my.cnf # We read this for port info
│ └── mysql/mysqld.sock # We connect via this socket
└── WP7lolWDi/ # Another site (if multiple running)
├── conf/mysql/my.cnf
└── mysql/mysqld.sock
The server intelligently finds the active site and connects to the right MySQL instance.
Usage Examples
Once connected, you can use the mysql_query tool to execute a permitted read-only SQL query against your Local WordPress database:
Getting Recent Posts
SELECT ID, post_title, post_date, post_status
FROM wp_posts
WHERE post_type = 'post' AND post_status = 'publish'
ORDER BY post_date DESC
LIMIT 5;
Exploring Database Structure
-- See all tables
SHOW TABLES;
-- Examine a table structure
DESCRIBE wp_posts;
-- Get table info
SHOW TABLE STATUS LIKE 'wp_%';
WordPress-Specific Queries
-- Get site options
SELECT option_name, option_value
FROM wp_options
WHERE option_name IN ('blogname', 'blogdescription', 'admin_email');
-- Find active plugins
SELECT option_value
FROM wp_options
WHERE option_name = 'active_plugins';
-- Get user information
SELECT user_login, user_email, display_name
FROM wp_users
LIMIT 10;
-- Post meta data
SELECT p.post_title, pm.meta_key, pm.meta_value
FROM wp_posts p
JOIN wp_postmeta pm ON p.ID = pm.post_id
WHERE p.post_type = 'post' AND pm.meta_key = '_edit_last';
Development Setup
Running from Source
-
Start a Local site: Make sure you have an active Local by Flywheel site running
-
Clone and build:
git clone https://github.com/verygoodplugins/mcp-local-wp.git cd mcp-local-wp npm install npm run build -
Test the connection:
node dist/index.js
Development Mode
npm run dev
This runs the server with TypeScript watching for changes.
Linting & Formatting
- Lint:
npm run lint - Fix lint:
npm run lint:fix - Format:
npm run format - Check formatting:
npm run format:check
Standards are unified across MCP servers via ESLint + Prettier.
Troubleshooting
Common Issues
-
"No active MySQL process found"
- Ensure Local by Flywheel is running
- Make sure at least one site is started in Local
- Check that the site's database is running
-
"MySQL socket not found"
- Verify the Local site is fully started
- Try stopping and restarting the site in Local
- Check Local's logs for MySQL startup issues
-
Connection refused
- Ensure the Local site's MySQL service is running
- Check if another process is using the MySQL port
- Try restarting Local by Flywheel
-
Permission denied
- Make sure the MySQL socket file has correct permissions
- Check if your user has access to Local's directories
Manual Configuration
If auto-detection fails, you can manually configure the connection:
export MYSQL_SOCKET_PATH="/path/to/your/local/site/mysql/mysqld.sock"
export MYSQL_DB="local"
export MYSQL_USER="root"
export MYSQL_PASS="root"
Debugging
Enable debug logging by setting DEBUG:
DEBUG=mcp-local-wp mcp-local-wp
Security
mysql_query accepts one SELECT/SHOW/DESCRIBE/DESC/EXPLAIN statement, including SELECT queries beginning with WITH or WITH RECURSIVE. CTE query bodies and the final query expression must resolve to SELECT, including nested WITH … SELECT and parenthesized queries; WITH … UPDATE/DELETE is rejected. MariaDB’s CYCLE … RESTRICT clause is supported for cycle detection. A tokenizer checks real SQL tokens using the connection's SQL mode. Executable MySQL/MariaDB comments, optimizer hints, file output, SELECT INTO, locking reads, advisory-lock functions, and EXPLAIN ANALYZE are rejected throughout the statement, including CTE bodies. Ordinary comments and semicolons in quoted values are supported.
Every read runs in a database-enforced read-only transaction on a dedicated connection. Setup failures stop execution; failed cleanup discards the connection. MYSQL_ALLOW_WRITES=true exposes mysql_write on a separate connection; it never disables protection for mysql_query. Write statements permit INSERT/UPDATE/DELETE. UPDATE/DELETE require column comparisons to bound parameters in WHERE, optionally grouped with AND/OR; IN, BETWEEN and LIKE also support bound values. Bare placeholder and literal-only predicates are rejected. Schema operations and write subqueries remain blocked.
For extra protection, configure a dedicated account with SELECT grants on the chosen database and no FILE or EXECUTE privileges. MYSQL_USER and MYSQL_PASS apply to auto-detected Local sites as well as manual connections. The server does not create users or change grants. Read-only transactions are not a sandbox for temporary tables or arbitrary native extensions; use least-privilege credentials for untrusted databases.
This server supports local development, with Unix sockets when available and TCP for explicit connections. Report vulnerabilities privately through GitHub Security Advisories or [email protected].
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Development Guidelines
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature-name - Make your changes and add tests
- Ensure TypeScript compiles:
npm run build - Submit a pull request
License
GPL-3.0-or-later - see the LICENSE file for details. As a WordPress-focused tool, we embrace the copyleft philosophy to ensure this remains free and open for the community.
Support
- GitHub Issues: Report bugs or request features
- Documentation: This README and inline code documentation
- Community: Join the Model Context Protocol community discussions
Related Projects
- mcp-server-mysql - The original MySQL MCP server that inspired this WordPress-specific version
- Local by Flywheel - The local WordPress development environment this server is designed for
- Model Context Protocol - The protocol specification
Built with 🧡 by Jack Arturo at Very Good Plugins · Made with love for the open-source community
