使用说明
项目简介
本项目 'WordPress MCP Server' 是一个实现了 Model Context Protocol (MCP) 协议的服务器,旨在为大型语言模型(LLM)客户端提供访问和操作 WordPress 网站内容和功能的标准化接口。它允许 LLM 通过 MCP 协议调用预定义的工具,与 WordPress 网站进行交互,例如获取文章、页面、媒体信息,甚至执行更复杂的操作。
主要功能点
- 发现 WordPress REST API 接口: 能够自动发现目标 WordPress 网站上可用的 REST API 接口,为后续操作提供基础。
- 提供常用 WordPress API 操作工具: 内置了多个常用的 WordPress REST API 操作工具,例如获取文章列表、调用任意 API 接口、列出常用接口等,简化了 LLM 与 WordPress 的交互。
- 支持 SSE 传输协议: 支持 Server-Sent Events (SSE) 传输协议,方便浏览器和 AI 工具集成,实现实时的双向通信。
- 基于 FastMCP 框架: 使用 FastMCP 框架开发,简化了服务器的搭建和部署过程。
安装步骤
- 安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm (Node Package Manager)。
- 下载仓库代码: 从 GitHub 仓库 https://github.com/zacktm/testmcp-server 下载代码到本地。
- 安装依赖: 在仓库根目录下打开终端,运行以下命令安装项目依赖:
npm install
服务器配置
MCP 客户端需要配置以下 JSON 信息才能连接到 WordPress MCP 服务器。请根据你选择的启动方式配置 'command' 和 'args'。
{ "serverName": "wordpress-mcp-server", "command": "node", "args": ["wp_mcp_server.js"], "transport": "sse", "port": 8080, "description": "连接到 WordPress MCP 服务器 (SSE 传输)", "notes": "使用 'wp_mcp_server.js' 启动服务器,支持 SSE 传输,监听 8080 端口。" }
参数注释:
- 'serverName': MCP 服务器的名称,可以自定义。
- 'command': 启动 MCP 服务器的命令,这里是 'node',表示使用 Node.js 运行 JavaScript 文件。
- 'args': 传递给 'command' 的参数,这里是 '["wp_mcp_server.js"]',指定要运行的服务器文件。 如果你想使用传统的 Stdio 传输方式,可以使用 '["mcp_server.js"]',并修改 'transport' 为 'stdio' (但本仓库的 'mcp_server.js' 默认配置为 Stdio,无需显式指定)。
- 'transport': MCP 服务器使用的传输协议,这里配置为 'sse' (Server-Sent Events)。 如果使用 'mcp_server.js' 启动,则默认使用 'stdio' 传输,无需在客户端特别配置此项,或者配置为 '"stdio"'。
- 'port': 当使用 'sse' 传输时,需要指定服务器监听的端口,默认为 '8080'。 如果使用 'stdio' 传输,则不需要 'port' 配置。
- 'description': 对该服务器配置的描述,方便客户端用户理解。
- 'notes': 更详细的备注信息,可以记录启动方式等。
注意:
- 配置文件 'sites.json' (默认从 'https://sparkrypt.com/sites.json' 加载,也可以本地配置) 中需要配置 WordPress 站点的 URL、用户名和应用密码。请根据实际情况修改配置文件,确保 MCP 服务器可以连接到你的 WordPress 站点。
- 如果要使用传统的 Stdio 传输方式,可以使用 'npm run start:legacy' 启动服务器,并相应修改客户端的 'command' 和 'args' 配置,例如:
{ "serverName": "wordpress-mcp-server-stdio", "command": "node", "args": ["mcp_server.js"], "transport": "stdio", "description": "连接到 WordPress MCP 服务器 (Stdio 传输)", "notes": "使用 'mcp_server.js' 或 'npm run start:legacy' 启动服务器,使用 Stdio 传输。" }
基本使用方法
-
启动 MCP 服务器: 在仓库根目录下打开终端,根据你选择的传输方式运行以下命令启动服务器:
- SSE 传输: 'npm start' (默认监听 'http://localhost:8080/sse')
- Stdio 传输 (Legacy): 'npm run start:legacy' (通过标准输入/输出通信)
-
配置 MCP 客户端: 在 MCP 客户端中,根据上述 "服务器配置" 部分的说明,配置连接到 WordPress MCP 服务器的信息。确保客户端能够正确连接到服务器。
-
使用 MCP 工具: 客户端连接成功后,可以使用以下工具与 WordPress 站点交互:
-
'wp_discover_endpoints': 发现指定 WordPress 站点的所有 REST API 接口。需要提供 'site' 参数 (站点别名,例如 'site1')。
{ "tool_call": { "name": "wp_discover_endpoints", "arguments": { "site": "site1" } } } -
'wp_call_endpoint': 调用 WordPress REST API 接口。需要提供 'site' (站点别名), 'endpoint' (接口路径或常用接口 Key,例如 'GET_POSTS', '/wp/v2/posts'), 'method' (HTTP 方法,例如 'GET', 'POST'), 和 'params' (请求参数)。
{ "tool_call": { "name": "wp_call_endpoint", "arguments": { "site": "site1", "endpoint": "GET_POSTS", "method": "GET", "params": { "per_page": 5 } } } } -
'wp_list_common_endpoints': 列出指定 WordPress 站点的常用 REST API 接口及其描述。需要提供 'site' 参数 (站点别名)。
{ "tool_call": { "name": "wp_list_common_endpoints", "arguments": { "site": "site1" } } }
请参考仓库的 'README.md' 和代码注释获取更详细的工具参数和使用方法。
-
信息
分类
网页与API