docs.modx.pro
  1. Extras
  2. MODX3MCP

MODX3MCP ​

MODX3MCP is a component for connecting external AI agents to MODX Revolution 3.x through the Model Context Protocol (MCP).

It provides agents with a specialized interface for working with resources, templates, chunks, snippets, TVs, system settings, and other MODX entities.

Внимание

MODX3MCP is not a ready-made AI agent and does not add artificial intelligence to MODX by itself.

Installing the component does not add a chat interface to the MODX manager for assigning tasks. The AI agent and user interface are configured separately.

General workflow:

text
User → AI agent → MODX3MCP → MODX

Features ​

Version 1.2.0 provides 192 operations: 81 read operations and 111 write operations.

Supported areas include:

  • resources and site structure;
  • templates, chunks, and snippets;
  • plugins;
  • TVs;
  • system settings;
  • users and groups;
  • access policies and policy templates;
  • resource groups and their members;
  • media sources;
  • packages and extras;
  • ClientConfig settings;
  • MIGX;
  • miniShop2;
  • VersionX;
  • VirtualPage.

MODX3MCP can also analyze relationships between site elements using a dependency graph.

Version 1.2.0 adds protection against writes based on stale site state. An agent can read the current project revision, and before a change MODX3MCP verifies that the state has not changed. If another agent or process has already modified the site, the operation is rejected with STALE_STATE instead of overwriting newer changes.

Potentially dangerous capabilities can be restricted or disabled through the component settings.

Installation ​

The recommended method is to install MODX3MCP as a regular MODX extra through the package manager from the modstore.pro repository.

The transport package can also be downloaded manually from the project releases on GitHub.

For MODX Revolution 3.x, use:

text
modx3mcp-1.2.0-pl.transport.zip

On first installation, the component automatically creates the modxmcp.api_token API token required to access MODX3MCP.

Compatibility ​

  • MODX Revolution 3.2 or later;
  • PHP 8.1 or later.

Source code ​

The project is distributed free of charge under the MIT License.

Source code and releases:

github.com/rumata-estor/modx3-mcp