@automattic/mcp-wordpress-remote 0.1.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+# MCP WordPress Remote
+
+The mcp-wordpress-remote package acts as a bridge between local Model Context Protocol (MCP) clients and remote WordPress MCP servers. By leveraging npx, you can execute this package without a global installation, simplifying the setup process.
+
+## WordPress MCP plugin
+
+You have to install the [wordpress-mcp](https://github.com/Automattic/wordpress-mcp) plugin on your WordPress website.
+
+## Why
+
+1. Most of the clients does not suport SSE or Streamable communications protocols.
+2. Improved eficiency. This proxy will not keep an open connection to your website, and it will only make simple REST API requests to your website when needed.
+3. Oauth2.1 is not yet available on wordpress out of the box.
+4. Security trough WordPress API passwords and WooCommerce REST API cosumer key and secret
+5. Easy to use. See installation instructions below.
+
+## Usage
+
+### Environment Variables
+
+The following environment variables are required:
+
+- `WP_API_URL`: The URL of your WordPress site (e.g., `https://example.com`)
+- `WP_API_USERNAME`: Your WordPress username
+- `WP_API_PASSWORD`: Your WordPress API password
+- `WOO_CUSTOMER_KEY`: Your Woocommerce customer key (optional, if you intend to use WooCommerce MCP assets)
+- `WOO_CUSTOMER_SECRET`: Your WooCommerce customer secret (optional, if you intend to use WooCommerce MCP assets)
+- `LOG_FILE`: Optional full path to a log file
+
+### Configuration in MCP Clients
+
+#### Claude Desktop
+
+In order to add an MCP server to Claude Desktop you need to edit the configuration file located at:
+
+- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+
+Example configuration:
+
+```json
+{
+  "mcpServers": {
+    "wordpress-mcp": {
+      "command": "npx",
+      "args": ["@Automattic/mcp-wordpress-remote"],
+      "env": {
+        "WP_API_URL": "https://your-wordpress-site.com",
+        "WP_API_USERNAME": "your-username",
+        "WP_API_PASSWORD": "your-password",
+        "WOO_CUSTOMER_KEY": "your-woo-customer-key",
+        "WOO_CUSTOMER_SECRET": "your-woo-customer-secret",
+        "LOG_FILE": "optional full path to the log file"
+      }
+    }
+  }
+}
+```
+
+https://woocommerce.com/document/woocommerce-rest-api/
+
+#### Cursor
+
+The configuration file is located at `~/.cursor/mcp.json`.
+
+Example configuration:
+
+```json
+{
+  "mcpServers": {
+    "wordpress-mcp": {
+      "command": "npx",
+      "args": ["@Automattic/mcp-wordpress-remote"],
+      "env": {
+        "WP_API_URL": "https://your-wordpress-site.com",
+        "WP_API_USERNAME": "your-username",
+        "WP_API_PASSWORD": "your-password",
+        "WOO_CUSTOMER_KEY": "your-woo-customer-key",
+        "WOO_CUSTOMER_SECRET": "your-woo-customer-secret",
+        "LOG_FILE": "optional full path to the log file"
+      }
+    }
+  }
+}
+```
+
+## @todo
+
+As of now, this package is in its early development stages. Any suggestions, bugreports, PR's are welcome.

package/dist/proxy.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/proxy.js

@@ -0,0 +1,274 @@
+#!/usr/bin/env node
+
+// src/proxy.ts
+import { Server } from "@modelcontextprotocol/sdk/server/index.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+
+// src/lib/utils.ts
+import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js";
+import * as fs from "node:fs";
+import * as path from "node:path";
+var LOG_DIR = process.env.LOG_DIR || path.join(process.cwd(), "logs");
+var LOG_FILE = process.env.LOG_FILE || path.join(LOG_DIR, "mcp-proxy.log");
+if (process.env.LOG_FILE || process.env.LOG_DIR) {
+  const logDir = path.dirname(LOG_FILE);
+  if (!fs.existsSync(logDir)) {
+    fs.mkdirSync(logDir, { recursive: true });
+  }
+}
+function log(message, ...args) {
+  const timestamp = (/* @__PURE__ */ new Date()).toISOString();
+  const formattedArgs = args.length > 0 ? args.map((arg) => typeof arg === "object" ? JSON.stringify(arg) : arg).join(" ") : "";
+  const logMessage = `${timestamp}: ${message}${formattedArgs ? " " + formattedArgs : ""}
+`;
+  if (process.env.LOG_FILE || process.env.LOG_DIR) {
+    fs.appendFileSync(LOG_FILE, logMessage);
+  }
+}
+
+// src/lib/wordpress-api.ts
+function validateEnvironment() {
+  const requiredEnvVars = ["WP_API_URL", "WP_API_USERNAME", "WP_API_PASSWORD"];
+  const missingVars = requiredEnvVars.filter((varName) => !process.env[varName]);
+  if (missingVars.length > 0) {
+    throw new Error(
+      `Missing required environment variables: ${missingVars.join(
+        ", "
+      )}. Please set these variables before starting the server.`
+    );
+  }
+}
+async function wpRequest(params = { method: "init" }) {
+  validateEnvironment();
+  const endpoint = "wp/v2/wpmcp";
+  const method = "POST";
+  const baseUrl = process.env.WP_API_URL;
+  log(`Request method: ${params.method || "init"}`);
+  log(`Request args: ${JSON.stringify(params.args || {})}`);
+  let username;
+  let password;
+  if (params.method === "tools/call" && params.args && params.args.tool && params.args.tool.startsWith("wc_reports_")) {
+    username = process.env.WOO_CUSTOMER_KEY;
+    password = process.env.WOO_CUSTOMER_SECRET;
+    log(`Using WooCommerce credentials for tool: ${params.args.tool}`);
+    if (!username || !password) {
+      throw new Error(
+        "Missing WooCommerce credentials. Please set WOO_CUSTOMER_KEY and WOO_CUSTOMER_SECRET environment variables."
+      );
+    }
+  } else {
+    username = process.env.WP_API_USERNAME;
+    password = process.env.WP_API_PASSWORD;
+    log(`Using WordPress credentials for method: ${params.method || "init"}`);
+  }
+  log(`Username length: ${username ? username.length : 0}`);
+  log(`Password length: ${password ? password.length : 0}`);
+  log(`Environment: ${process.env.NODE_ENV || "development"}`);
+  log(`API URL: ${baseUrl}`);
+  const auth = Buffer.from(`${username}:${password}`).toString("base64");
+  log(`Auth header length: ${auth.length}`);
+  const url = new URL(`/wp-json/${endpoint}`, baseUrl).toString();
+  log(`Requesting URL: ${url}`);
+  const headers = {
+    Authorization: `Basic ${auth}`,
+    "Content-Type": "application/json"
+  };
+  const fetchOptions = {
+    method,
+    headers,
+    body: JSON.stringify(params)
+  };
+  try {
+    log(`Sending request to WordPress API...`);
+    const response = await fetch(url, fetchOptions);
+    log(`Response status: ${response.status}`);
+    if (!response.ok) {
+      const errorText = await response.text();
+      log(`Error response: ${errorText}`);
+      throw new Error(`WordPress API error (${response.status}): ${errorText}`);
+    }
+    const responseData = await response.json();
+    log(`Response received successfully`);
+    return responseData;
+  } catch (error) {
+    log(`Error in wpRequest: ${error instanceof Error ? error.message : String(error)}`);
+    throw error;
+  }
+}
+
+// src/proxy.ts
+import {
+  CallToolRequestSchema,
+  ListResourcesRequestSchema,
+  ListToolsRequestSchema,
+  ListPromptsRequestSchema,
+  GetPromptRequestSchema,
+  ListResourceTemplatesRequestSchema,
+  ReadResourceRequestSchema,
+  SubscribeRequestSchema,
+  UnsubscribeRequestSchema,
+  SetLevelRequestSchema,
+  CompleteRequestSchema,
+  ListRootsRequestSchema
+} from "@modelcontextprotocol/sdk/types.js";
+async function WordPressProxy() {
+  const init = await wpRequest({ method: "init" });
+  const server = new Server(
+    {
+      name: init.serverInfo.name,
+      version: init.serverInfo.version
+    },
+    {
+      capabilities: init.capabilities
+      // Type assertion to fix linter error
+    }
+  );
+  const withLogging = (schema, handler) => async (request) => {
+    log(`Received ${schema} request:`, JSON.stringify(request));
+    const response = await handler(request);
+    log(`${schema} response:`, JSON.stringify(response));
+    return response;
+  };
+  server.setRequestHandler(
+    ListToolsRequestSchema,
+    withLogging("ListTools", async (request) => {
+      log("Processing ListToolsRequest");
+      const response = await wpRequest({
+        method: "tools/list",
+        cursor: request.params?.cursor
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    CallToolRequestSchema,
+    withLogging("CallTool", async (request) => {
+      log("Processing CallToolRequest");
+      const response = await wpRequest({
+        method: "tools/call",
+        name: request.params.name,
+        arguments: request.params.arguments
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    ListResourcesRequestSchema,
+    withLogging("ListResources", async (request) => {
+      log("Processing ListResourcesRequest");
+      const response = await wpRequest({
+        method: "resources/list",
+        cursor: request.params?.cursor
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    ListResourceTemplatesRequestSchema,
+    withLogging("ListResourceTemplates", async (request) => {
+      log("Processing ListResourceTemplatesRequest");
+      const response = await wpRequest({
+        method: "resources/templates/list",
+        cursor: request.params?.cursor
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    ReadResourceRequestSchema,
+    withLogging("ReadResource", async (request) => {
+      log("Processing ReadResourceRequest");
+      const response = await wpRequest({
+        method: "resources/read",
+        uri: request.params.uri
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    SubscribeRequestSchema,
+    withLogging("Subscribe", async (request) => {
+      log("Processing SubscribeRequest");
+      const response = await wpRequest({
+        method: "resources/subscribe",
+        uri: request.params.uri
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    UnsubscribeRequestSchema,
+    withLogging("Unsubscribe", async (request) => {
+      log("Processing UnsubscribeRequest");
+      const response = await wpRequest({
+        method: "resources/unsubscribe",
+        uri: request.params.uri
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    ListPromptsRequestSchema,
+    withLogging("ListPrompts", async (request) => {
+      log("Processing ListPromptsRequest");
+      const response = await wpRequest({
+        method: "prompts/list",
+        cursor: request.params?.cursor
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    GetPromptRequestSchema,
+    withLogging("GetPrompt", async (request) => {
+      log("Processing GetPromptRequest");
+      const response = await wpRequest({
+        method: "prompts/get",
+        name: request.params.name,
+        arguments: request.params.arguments
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    SetLevelRequestSchema,
+    withLogging("SetLevel", async (request) => {
+      log("Processing SetLevelRequest");
+      const response = await wpRequest({
+        method: "logging/setLevel",
+        level: request.params.level
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    CompleteRequestSchema,
+    withLogging("Complete", async (request) => {
+      log("Processing CompleteRequest");
+      const response = await wpRequest({
+        method: "completion/complete",
+        ref: request.params.ref,
+        argument: request.params.argument
+      });
+      return response;
+    })
+  );
+  server.setRequestHandler(
+    ListRootsRequestSchema,
+    withLogging("ListRoots", async (request) => {
+      log("Processing ListRootsRequest");
+      const response = await wpRequest({
+        method: "roots/list"
+      });
+      return response;
+    })
+  );
+  const transport = new StdioServerTransport();
+  server.connect(transport).then(() => {
+    log("MCP server connected to transport successfully");
+  }).catch((error) => {
+    log(`Error starting MCP server:`, error);
+    process.exit(1);
+  });
+}
+WordPressProxy();

package/package.json

@@ -0,0 +1,75 @@
+{
+	"name": "@automattic/mcp-wordpress-remote",
+	"version": "0.1.6",
+	"description": "MCP WordPress Remote proxy server",
+	"keywords": [
+		"mcp",
+		"wordpress",
+		"remote",
+		"proxy"
+	],
+	"author": "Automattic Inc.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Automattic/mcp-wordpress-remote.git"
+	},
+	"type": "module",
+	"files": [
+		"dist",
+		"README.md",
+		"LICENSE"
+	],
+	"main": "dist/proxy.js",
+	"bin": {
+		"@automattic/mcp-wordpress-remote": "dist/proxy.js"
+	},
+	"scripts": {
+		"build": "tsup",
+		"build:watch": "tsup --watch",
+		"check": "prettier --check . && tsc",
+		"start": "node dist/proxy.js",
+		"dev": "NODE_ENV=development node dist/proxy.js",
+		"test": "jest",
+		"test:watch": "jest --watch"
+	},
+	"dependencies": {
+		"@modelcontextprotocol/sdk": "^1.8.0",
+		"express": "^4.18.2",
+		"open": "^10.0.0"
+	},
+	"devDependencies": {
+		"@types/express": "^4.17.21",
+		"@types/jest": "^29.5.12",
+		"@types/node": "^20.11.19",
+		"jest": "^29.7.0",
+		"prettier": "^3.2.5",
+		"ts-jest": "^29.1.2",
+		"tsup": "^8.0.2",
+		"typescript": "^5.3.3"
+	},
+	"tsup": {
+		"entry": [
+			"src/proxy.ts"
+		],
+		"format": [
+			"esm"
+		],
+		"dts": true,
+		"clean": true,
+		"outDir": "dist"
+	},
+	"jest": {
+		"preset": "ts-jest",
+		"testEnvironment": "node",
+		"testMatch": [
+			"**/__tests__/**/*.ts",
+			"**/?(*.)+(spec|test).ts"
+		],
+		"moduleFileExtensions": [
+			"ts",
+			"js",
+			"json",
+			"node"
+		]
+	}
+}