使用说明（Markdown 格式）

项目简介
- 该仓库实现了一个 MCP 服务器，专为 Local by Flywheel 的 WordPress 数据库设计。它会自动检测正在运行的本地 MySQL 实例，并通过只读的 SQL 工具向 LLM 客户端提供数据访问能力与数据库结构查询等功能，帮助 AI 客户端准确理解并查询实际数据。
主要功能点
- MCP 服务器核心能力：实现对 MCP 请求（如读取资源、调用工具、获取 Prompts 等）进行响应的能力，基于 JSON-RPC 与客户端通信。
- 工具集合（Tools）：提供 mysql_query（执行只读 SQL）、mysql_schema（浏览数据库/表结构与索引）的工具，支持对输入进行参数化查询与结构化输出。
- 自动检测本地数据库：通过进程检测与文件系统扫描，自动识别 Local by Flywheel 的 MySQL 连接信息（socket、端口、站点 ID），确保 AI 能看到真实的数据库结构与数据（只用于只读查询）。
- 安全性设计：严格限制为只读操作，单次请求不可执行多条语句，确保对本地环境的最小风险暴露。
- 多环境支持：可通过环境变量覆盖配置，支持非 Local 场景的回退配置（如 MYSQL_HOST/PORT/USER/PASS 等）。
安装步骤
1. 克隆仓库并安装依赖
  - git clone https://github.com/verygoodplugins/mcp-local-wp.git
  - cd mcp-local-wp
  - npm install
2. 构建与运行
  - npm run build
  - node dist/index.js
3. 调试与开发辅助
  - 使用 DEBUG=mcp-local-wp node dist/index.js 以开启调试信息
  - 如需本地开发模式，可执行 npm run dev
服务器配置（MCP 客户端需要的最小信息）说明：MCP 客户端需要知道如何启动并连接到该 MCP 服务器。下面给出最小可用的配置信息，需在客户端配置中指定 server name、启动命令和参数等。请确保 server_name 与实际服务器名称保持一致。服务器配置示例（JSON 文本，非代码块，便于直接粘贴到客户端的配置接口中）： { "mcpServers": { "mcp-local-wp": { "comment": "本地 WordPress MCP 服务器，使用 npx 启动最新版本的 mcp-local-wp", "command": "npx", "args": ["-y", "@verygoodplugins/mcp-local-wp@latest"] } // 备注：如果你在自己的环境中需要替换为本地构建的 dist/index.js，请将命令改为 node，参数为完整的 dist/index.js 路径。 } }
基本使用方法
1. 启动 MCP 服务器
  - 通过以上配置，在客户端启动 mcp-local-wp 服务后，服务器会在标准输出中显示已启动信息，如“WordPress Local MCP Server running…”。
2. 连接与交互
  - 在支持 MCP 的客户端（如 Cursor、Claude Desktop 等）中选择名为 mcp-local-wp 的服务器进行连接。
  - 使用 mysql_query 工具执行只读 SQL、使用 mysql_schema 工具查看数据库表与列信息。
3. 常见操作
  - 查询数据：通过 mysql_query 执行 SELECT/SHOW/DESCRIBE/EXPLAIN 等只读语句，参数化查询将以安全方式执行。
  - 浏览结构：通过 mysql_schema 获取数据库表清单、某表的列信息与索引信息。
4. 问题排查
  - 若首次连接失败，请确保 Local by Flywheel 已经启动且数据库处于运行状态，且服务器成功检测到一个活动的本地 MySQL 实例。
  - 如遇到连接问题，可以开启 DEBUG=mcp-local-wp 以获得详细日志。
备注
- 该实现当前聚焦核心工具（mysql_query、mysql_schema）及本地 MySQL 的安全访问，遵循只读原则，且对多语句提交做了限制，适合在本地开发和调试场景中帮助 LLM 理解并操作本地 WordPress 数据库。

关键词

信息