WP Engine MCP Server

WP Engine MCP 服务

这是一个用于 WP Engine API 的 MCP 服务 TypeScript 实现。它提供用于与 WP Engine 账户、站点、安装和备份交互的工具和资源。该服务支持本地（stdio）和远程（HTTP）传输方式。

功能

• 获取账户信息
• 获取站点信息
• 获取安装信息
• 获取和创建备份
• 支持本地和远程 MCP 连接
• 支持带身份验证的 HTTP 传输
• 全面的日志记录和错误处理

安装

1. 克隆此代码库
2. 安装依赖项：

   npm install
   

3. 构建服务：

   npm run build
   

配置

该服务需要 WP Engine API 凭据才能通过 WP Engine API 进行身份验证。你可以在 WP Engine Portal 的 API Access 页面获取这些凭据：https://my.wpengine.com/api_access

设置以下环境变量：

• WP_ENGINE_API_USERNAME：你的 WP Engine API 用户名
• WP_ENGINE_API_PASSWORD：你的 WP Engine API 密码

用法

本地 MCP 服务（stdio 传输）

用于 Claude Desktop 等本地 MCP 客户端：

npm run start:stdio

也可以使用环境变量：

WP_ENGINE_API_USERNAME="your-username" WP_ENGINE_API_PASSWORD="your-password" npm run start:stdio

远程 MCP 服务（HTTP 传输）

使用环境变量通过 HTTP 进行远程访问：

WP_ENGINE_API_USERNAME=my-api-username WP_ENGINE_API_PASSWORD=my-api-password npm run start

这会运行支持远程传输的默认服务（build/index.js）。你也可以使用自定义选项运行：

WP_ENGINE_API_USERNAME="your-username" WP_ENGINE_API_PASSWORD="your-password" node build/main.js --transport=http --port=8080 --auth-token=my-secure-token

命令行选项

node build/main.js [options]

Options:
  -h, --help                 Show help message
  -v, --version              Show version information
  -t, --transport <type>     Transport type (stdio, http) [default: stdio]
  -p, --port <port>          Port for HTTP transport [default: 3000]
  -a, --auth-token <token>   Authentication token for HTTP transport [default: wpengine-mcp-token]

MCP 设置

本地配置（stdio 传输）

将以下配置添加到 MCP 设置文件中：

{
  "mcpServers": {
    "wpengine": {
      "command": "node",
      "args": [
        "/path/to/wpengine-mcp-ts/build/main.js"
      ],
      "env": {
        "WP_ENGINE_API_USERNAME": "your-api-username",
        "WP_ENGINE_API_PASSWORD": "your-api-password"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

远程配置（HTTP 传输）

如需建立远程 MCP 连接，你需要实现一个 HTTP MCP 客户端，或将该服务用作远程服务。该服务在 /mcp 提供一个 HTTP 端点，用于接收 MCP 协议消息。

HTTP 请求示例：

curl -X POST http://localhost:3000/mcp \
  -H "Authorization: Bearer wpengine-mcp-token" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "tools/list",
    "params": {}
  }'

可用工具

该服务提供全面的工具，用于管理 WP Engine 基础设施：

账户管理

• get_accounts - 获取所有 WP Engine 账户
• get_current_user - 获取当前经过身份验证的用户

站点管理

• get_sites - 获取 WP Engine 账户的所有站点
• create_site - 创建新站点
• update_site - 更改站点名称
• delete_site - 删除站点及其关联的所有安装（永久操作）

安装管理

• get_installs - 获取 WP Engine 站点的所有安装
• create_install - 创建新的 WordPress 安装
• update_install - 更新 WordPress 安装
• delete_install - 按 ID 删除安装（永久操作）

备份管理

• get_backups - 获取 WP Engine 安装的所有备份
• create_backup - 为 WP Engine 安装创建新备份

域名管理

• get_domains - 获取安装的域名
• create_domain - 为现有安装添加新域名
• update_domain - 将现有域名设为主域名或配置重定向
• delete_domain - 删除安装的指定域名

缓存管理

• purge_cache - 清除安装的缓存（对象、页面、CDN 或全部）

SSH 密钥管理

• get_ssh_keys - 获取你的 SSH 密钥
• create_ssh_key - 添加新的 SSH 密钥
• delete_ssh_key - 删除现有 SSH 密钥

工具用法示例

获取所有账户

{
  "name": "get_accounts",
  "arguments": {}
}

创建新站点

{
  "name": "create_site",
  "arguments": {
    "name": "My New Site",
    "account_id": "account-uuid"
  }
}

创建新安装

{
  "name": "create_install",
  "arguments": {
    "name": "mysite",
    "account_id": "account-uuid",
    "site_id": "site-uuid",
    "environment": "staging"
  }
}

创建备份

{
  "name": "create_backup",
  "arguments": {
    "install_id": "install-uuid",
    "description": "Pre-deployment backup",
    "notification_emails": ["[email protected]"]
  }
}

添加域名

{
  "name": "create_domain",
  "arguments": {
    "install_id": "install-uuid",
    "name": "example.com",
    "primary": true
  }
}

清除缓存

{
  "name": "purge_cache",
  "arguments": {
    "install_id": "install-uuid",
    "type": "all"
  }
}

可用资源

账户信息

wpengine://account/{accountId}

账户站点

wpengine://account/{accountId}/sites

站点信息

wpengine://site/{siteId}

站点安装

wpengine://site/{siteId}/installs

安装信息

wpengine://install/{installId}

安装备份

wpengine://install/{installId}/backups

测试

本地测试（stdio 传输）

你可以使用 MCP 检查器测试该服务：

WP_ENGINE_API_USERNAME="your-api-username" WP_ENGINE_API_PASSWORD="your-api-password" npx @modelcontextprotocol/inspector build/main.js

远程测试（HTTP 传输）

1. 以 HTTP 模式启动服务：

   WP_ENGINE_API_USERNAME="your-username" WP_ENGINE_API_PASSWORD="your-password" npm run start:http
   

2. 在另一个终端中运行测试客户端：

   node test-http-client.js
   

测试客户端将验证 HTTP 传输是否正常工作，并测试各种 MCP 操作。

安全注意事项

使用 HTTP 传输时：

1. 身份验证：服务使用 Bearer 令牌身份验证。请在生产环境中更改默认令牌。
2. HTTPS：考虑在生产环境中使用 HTTPS。
3. 防火墙：仅允许可信网络访问 HTTP 端口。
4. 环境变量：安全存储 API 凭据，切勿将其提交到版本控制系统。

开发

构建

npm run build

监视更改

npm run watch

项目结构

wpengine-mcp-ts/
├── src/
│   ├── main.ts              # Main entry point with transport selection
│   ├── index.ts             # Original stdio-only implementation
│   └── transport/
│       └── http.ts          # HTTP transport implementation
├── build/                   # Compiled JavaScript output
├── test-http-client.js      # HTTP transport test client
└── package.json

许可证

MIT