使用说明
项目简介
WordPress MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在将 WordPress 网站的内容和功能以标准化的方式暴露给大型语言模型 (LLM) 客户端,例如 Claude Desktop。通过此服务器,用户可以使用自然语言与 WordPress 网站进行交互,实现内容管理、插件管理等功能。
主要功能点
- 内容管理: 支持对 WordPress 的文章 (Posts)、页面 (Pages)、媒体 (Media)、评论 (Comments) 和分类目录 (Categories) 进行CRUD操作(创建、读取、更新、删除)和列表查询。
- 用户管理: 支持对 WordPress 用户 (Users) 进行列表查询和信息获取。
- 插件管理: 支持对 WordPress 插件 (Plugins) 进行列表查询、信息获取、激活、停用和创建(从 WordPress.org 仓库安装)。
- 插件仓库搜索: 支持在 WordPress.org 插件仓库中搜索插件并获取详细信息。
- 标准化协议: 基于 MCP 协议,易于与兼容 MCP 协议的 LLM 客户端集成。
- 灵活部署: 可以通过 npx 直接运行,或使用 npm 构建后部署。
- 工具化能力: 将 WordPress 功能封装为一系列工具 (Tools),方便 LLM 客户端按需调用。
安装步骤
-
环境准备:
- 确保已安装 Node.js (版本 18 或更高) 和 npm。
- 确保已有一个可访问的 WordPress 网站,并已启用 REST API 功能。
- 在 WordPress 网站上设置 REST API 身份验证,推荐使用应用密码 (Application Passwords)。
-
克隆仓库:
git clone https://github.com/InstaWP/mcp-wp cd mcp-wp -
安装依赖:
npm install -
配置环境变量:
- 在项目根目录下创建 '.env' 文件,并填入 WordPress API 相关信息:
请将 placeholders 替换为您的实际 WordPress 网站信息。WORDPRESS_API_URL=https://your-wordpress-site.com # 您的WordPress网站URL WORDPRESS_USERNAME=wp_username # 您的WordPress用户名 WORDPRESS_PASSWORD=wp_app_password # 您的WordPress应用密码
- 在项目根目录下创建 '.env' 文件,并填入 WordPress API 相关信息:
-
构建项目 (可选): 如果需要构建打包后的服务器文件,运行:
npm run build构建后的服务器文件位于 'build/server.js'。
服务器配置
对于 MCP 客户端(例如 Claude Desktop),您需要配置 MCP 服务器的连接信息。以下是一个 'claude_desktop_config.json' 配置文件示例,用于连接到 WordPress MCP Server:
{ "mcpServers": [ { "name": "wordpress-mcp-server", // MCP 服务器名称,自定义 "command": "npx", // 启动命令,使用 npx 运行 "args": ["@instawp/mcp-wp"] // 命令参数,运行 mcp-wp 包 // 如果您选择构建项目,并使用 npm start 启动,则配置如下: // "command": "npm", // "args": ["start"] } ] }
配置参数说明:
- name: MCP 服务器的名称,您可以自定义,用于在客户端中标识该服务器。
- command: 启动服务器的命令。
- 如果使用 'npx @instawp/mcp-wp' 方式运行,则设置为 '"npx"'。
- 如果使用 'npm start' 方式运行(在项目根目录已执行 'npm install' 和 'npm run build' 后),则设置为 '"npm"'。
- args: 启动命令的参数,以数组形式提供。
- 如果 'command' 设置为 '"npx"',则 'args' 设置为 '["@instawp/mcp-wp"]'。
- 如果 'command' 设置为 '"npm"',则 'args' 设置为 '["start"]'。
Claude Desktop 配置步骤:
- 打开 Claude Desktop 的设置。
- 导航到 "Developer"(开发者)选项卡。
- 点击 "Edit Config"(编辑配置)按钮,打开 'claude_desktop_config.json' 文件。
- 在 'mcpServers' 数组中添加上述 JSON 配置信息。
- 保存配置文件并重启 Claude Desktop。
基本使用方法
配置完成后,在 Claude Desktop 中,您可以像与普通 Claude Bot 对话一样,使用自然语言指示其操作 WordPress 网站。例如:
- '列出所有文章'
- '创建一个标题为 "我的新文章",内容为 "这是文章内容" 的文章'
- '搜索插件 "Yoast SEO" 并获取详细信息'
- '激活插件 "akismet"'
客户端会根据您的指令,调用 WordPress MCP Server 提供的工具,与您的 WordPress 网站进行交互,并将结果返回给您。
信息
分类
网页与API