List MODX elements of a type (id + name). Supports an optional name filter and pagination.

Convert a chunk/snippet/template/plugin to a static file under core/elements/ (writes the file, sets static=1 + source=Filesystem). One element via {type,id}, or a batch via {items:[{type,id}]}. Edit the resulting files directly afterwards. (See also the modxmcp.auto_static setting to do this automatically on every create/update.)

Read the connector-authoritative site revision and atomic-precondition capability used by Site Agent Runtime.

Read a MODX element (returns its fields + full code). For a large chunk/snippet/template/plugin you only need to edit, prefer modx_view_element (numbered, windowable) so you don't pull the whole body into context.

Change ONLY the value of one EXISTING default property of a snippet, chunk, plugin or template. Requires expected_value (compare-and-swap); preserves other property definitions and source code, uses standard MODX update processor.

Update a MODX element by REPLACING its whole content (send the complete new content). Best for small elements or full rewrites. For a few changes inside a large chunk/snippet/template/plugin, do NOT use this — use modx_view_element + modx_edit_element_lines instead (sends only the changed lines, far fewer tokens, atomic with a safety anchor).

Create a new MODX element.

Delete a MODX element. Run with dry_run:true FIRST — it returns what would be deleted plus where the element is still referenced (for resources: child-resource count), without deleting. Review that before the real delete.

View a chunk/snippet/template/plugin as NUMBERED lines (like cat -n), optionally windowed by start_line/end_line. Use this to find the exact line numbers to edit with modx_edit_element_lines — cheaper than pulling the whole element. Returns total_lines and the numbered window.

Edit a chunk/snippet/template/plugin BY LINE, sending only the changed lines (no need to resend the whole element). Each edit replaces the inclusive range [start_line..end_line] with replacement. Conventions: delete = replacement ""; insert before a line = set end_line to start_line-1. Strongly recommended: pass expect (the current text of those lines) as a safety anchor — it is verified, and relocated to its unique match if the line numbers drifted; any mismatch aborts the WHOLE call (atomic, nothing is written). MULTI-EDIT RULES: all line numbers refer to the file exactly as you last saw it in modx_view_element (the original) — do NOT adjust them for the effect of your other edits; the server applies edits together (bottom-up) so earlier inserts/deletes never shift later ones. Ranges must not overlap. So to change several spots in one big file, send them all in ONE call with original line numbers. Read first with modx_view_element to get line numbers.

List MODX system settings.

Get one MODX system setting by key.

Create a MODX system setting.

Update a MODX system setting by key.

Delete a MODX system setting by key.

List MODX media sources.

Get one MODX media source.

Create a media (file) source. class_key defaults to sources.modFileMediaSource. 'properties' is a {name:value} map of source params (e.g. {"basePath":"assets/files/","baseUrl":"assets/files/"}) merged into the source.

Update a media source. 'properties' is a {name:value} map merged into the source's params (others preserved) — use it to set basePath/baseUrl/etc.

Delete a media source by id.

List files and folders inside a media source.

Read a file inside a media source.

List installed MODX components from core/components and assets/components.

List files and folders inside an installed MODX component.

Read a file from an installed MODX component.

Get a resource's template-variable (TV) values.

Update a resource's template-variable (TV) values.

List explicitly stored values for one TV across all resources, including stale values on resources whose current template may no longer use that TV. Use before deleting or restructuring a TV.

Preview or clear every explicitly stored value for one TV. Safe by default: without confirm:true it only returns the number of stored values. Destructive; use only as part of the staged TV deletion workflow after backup.

List VersionX versions for a MODX resource, chunk, snippet, template, plugin, or TV.

Read one VersionX version payload before deciding whether to revert to it.

Revert a MODX object to a specific VersionX version. This changes live MODX data and requires confirm=true.

List available miniShop2 product option field types.

List miniShop2 product options from the settings options tab.

Read one miniShop2 product option by id.

Create a miniShop2 product option in settings options.

Update a miniShop2 product option in settings options.

Assign an existing miniShop2 option to an msCategory.

Read miniShop2 option values assigned to a product.

Create, update, or remove miniShop2 option values for a product. Use null value to remove an option value.

List VirtualPage events that bind route groups to MODX events.

Read one VirtualPage event by id or name, including its routes.

Create a VirtualPage event, usually OnPageNotFound or OnHandleRequest.

Update a VirtualPage event by id or name.

List VirtualPage handlers that render resources, snippets, chunks, or dynamic resources.

Read one VirtualPage handler by id or name, including routes that use it.

Create a VirtualPage handler. type can be resource, snippet, chunk, dynamic_resource/template, or 0..3.

Update a VirtualPage handler by id or name.

List VirtualPage routes with their event and handler names.

Read one VirtualPage route by id, or by route plus optional method.

Create a VirtualPage route and bind its event plugin if needed.

Update a VirtualPage route by id.

Simulate VirtualPage route matching and return handler plus vp.* placeholders.

Delete a VirtualPage event by id or name (removes its routes too, per the VP schema).

Delete a VirtualPage handler by id or name.

Delete a VirtualPage route by id or name.

Clear VirtualPage route/cache files and refresh MODX cache.

Full-text search across element and resource CONTENT (and names). Finds the chunk/snippet/template/plugin/TV/resource that contains a string, including where an element is referenced or mentioned. Matches static elements by reading their static file. Use this to navigate the codebase (e.g. query 'header' finds the header chunk and everything that uses or mentions it). Each content hit returns id, line (1-based line of the match) and line_text (the exact line, verbatim) — so for a one-line change you can go straight to modx_edit_element_lines using line as start_line/end_line and line_text as expect, with no separate read. For multi-line context, open a window with modx_view_element around line.

Find where an element is used: content matches for its name across all code, plus — if it is a template — the resources assigned to that template. Use before renaming/deleting an element.

List resources (the content tree), optionally filtered by parent, context, deleted state, or a pagetitle/alias/uri query. Returns id, pagetitle, alias, uri, parent, template, published, deleted, isfolder, class_key, context_key.

Site-wide search & replace across code elements (chunk/snippet/template/plugin): find every element whose CONTENT contains find and replace ALL occurrences with replacement, in ONE call (no per-element reads/writes from your side). Honours static files vs DB. SUBSTRING match — find:"foo" also matches inside footer/food; make find specific. ALWAYS run dry_run:true FIRST and review the returned preview (the exact lines that would change) before the real run. case_sensitive defaults to TRUE here. Use for renames / URL / class changes across the codebase. (Does not touch resources — edit those individually.)

Map how the site's elements WIRE TOGETHER, in one call: which template pulls which chunk/snippet/TV, which snippet renders which chunk, where each TV is attached. Returns nodes (elements, with in/out reference degree) + edges ([from_index, to_index, kind]) — plus missing (tags pointing at a chunk/snippet that does NOT exist — broken references) and orphans (elements nothing references — safe-to-delete candidates). Detects references in MODX tags, &tpl=chunk`` properties, $modx->getChunk()/runSnippet() in PHP, MIGX inputTV/renderchunktpl, and template↔TV attachments. Token-safe: it scales with the number of ELEMENTS, never with content (resources are counts, not nodes). USE IT: to understand an unfamiliar site's code structure after modx_project_overview; with focus before editing or deleting an element, to see exactly what depends on it (cheaper and more precise than modx_find_usages, which is a text search); with format:"summary" as a fast health check for broken/dead elements.

Schema introspection: list an xPDO class's fields (name + php/db type, null, default) and its primary key, so you use REAL field names instead of guessing. Accepts a class name (e.g. modResource) or an alias (resource/chunk/snippet/template/plugin/tv/category/user/context/setting). Use before create/update on an unfamiliar object.

Apply ONE operation to many resources at once: publish, unpublish, set_template (needs template), move (needs parent_to and/or context_to), or delete. Select targets by explicit ids OR by a parent/context/query filter. ALWAYS run dry_run:true FIRST — it reports the change per resource (and child-resource counts for delete) without applying. Changes go through the core resource processors (correct URI/events). Note: delete is a soft delete (moves resources to the MODX trash, recoverable), matching the manager.

Create a file inside a media source (writes content). source = source id or name, path = target directory (relative to the source base), name = filename, content = file body.

Overwrite a file's content inside a media source. source = id/name, path = file path within the source, content = new body.

Delete a file inside a media source. source = id/name, path = file path within the source.

Rename a file inside a media source. source = id/name, path = current file path, new_name = new filename.

Create a folder inside a media source. source = id/name, parent = parent directory (default root), name = folder name.

Delete a folder (and its contents) inside a media source. source = id/name, path = folder path within the source.

Duplicate a resource. id = source resource; optional name (new pagetitle), duplicate_children (bool), published_mode (preserve|publish|unpublish).

Duplicate an element (chunk/snippet/template/plugin/tv). type + id; optional name for the copy.

Restore a soft-deleted resource from the trash (un-deletes it). id = resource id.

Permanently purge ALL trashed (soft-deleted) resources. Irreversible — there is no further undo.

Reorder resources in the tree by setting menuindex (and optionally parent). items = [{id, menuindex, parent?}], applied per resource.

Read the tail of the MODX error log (core/cache/logs/error.log) for diagnostics. Optional limit (lines, default 100).

Regenerate all resource URIs (run after bulk alias/structure changes that left stale URIs).

Clear stale manager edit locks (when an element/resource is reported locked by a dead session).

Orient on the whole installed site in ONE compact, cheap call. Returns STRUCTURE + COUNTS (not content): template↔TV map, resource/product COUNTS (overall + by template + by context), a shallow resource tree (roots + child counts only), element categories, content types, contexts, installed integrations. Token-safe on huge sites (100k resources return the same small payload) — for per-item browsing use list_resources / list_elements. Call this FIRST when starting on an unfamiliar project. Optional sections to fetch only some parts; max_tree_nodes caps the tree roots.

Environment/diagnostic info: MODX version, modxMCP version, PHP version, db type, key paths.

Unsure which TV input type fits a need? Describe it (English or Russian) and get ranked candidate field_types with reasons + a ready-to-edit create_element skeleton for the top pick (with the extra keys that type needs). Deterministic helper for picking the right TV type; then create it with modx_create_element. See also the tv_input_types help topic.

List the TV input (widget) types available on this site. Core types come with use (when to pick each) and requires (extra create_element keys like elements/media_source) so you choose the right field_type for the task; plus any custom types other components register (e.g. MIGX adds 'migx'/'migxdb'). Use a key as field_type when creating a TV. See the tv_input_types help topic for full examples.

Report which popular MODX add-ons (miniShop2, MIGX, pdoTools, Tickets, etc.) are installed on this site and what modxMCP can do with each. Read-only.

Rotate the modxmcp.api_token to a fresh random value and return it. NOTE: this invalidates the current token — update MODX_MCP_TOKEN in your client config immediately, or the next call will be unauthorized.

List miniShop2 link types (msLink): id, type, name, description.

Get a miniShop2 link type by id.

Create a miniShop2 link type. 'type' is the relation kind that decides how products get linked.

Update a miniShop2 link type.

Delete a miniShop2 link type by id.

List product-to-product links (msProductLink), optionally for one product. Returns link type + master/slave with pagetitles.

Link two products under a link type. The link type's relation kind decides whether the reverse link is also created.

Remove a product link (by link type + master + slave).

List miniShop2 categories (msCategory).

Create a miniShop2 category (msCategory resource).

Update a miniShop2 category.

List miniShop2 orders (msOrder), filterable by status/customer/context/date range.

Get a miniShop2 order by id (with items/customer).

Update a miniShop2 order — typically to change its status (triggers ms2 status-change logic), delivery or payment.

List MIGX configurations (migxConfig): id, name, category, published.

Get a full MIGX configuration by id (formtabs, columns, buttons, filters, permissions — as stored JSON strings).

Create a MIGX configuration. formtabs/columns/contextmenus/actionbuttons/columnbuttons/filters are JSON strings (same format MIGX stores in the manager).

Update a MIGX configuration. Only the fields you pass are changed.

Delete a MIGX configuration by id.

List ClientConfig settings including context-specific values.

Get a ClientConfig setting by id or key.

Create a ClientConfig setting.

Update a ClientConfig setting by id or key.

Delete a ClientConfig setting by id or key.

List property sets (modPropertySet): id, name, description, category.

Get a property set by id (incl. its properties).

Create a property set. 'properties' is a JSON object of property definitions.

Update a property set.

Delete a property set by id.

Attach a property set to an element. Identify the element with its id + either element_class (e.g. 'modSnippet') or element_type ('snippet'/'chunk'/'template'/'plugin'/'tv').

Detach a property set from an element (same identification as assign).

Built-in documentation. Call with no args to list topics; pass {topic} for a guide (e.g. 'tv_input_types', 'study_component', 'minishop2', 'migx', 'acl', 'getting_started'). Read the relevant topic before unfamiliar work, or to learn how to use a newly-installed component.

List the action names this modxMCP server build supports, grouped by area. Use it to detect client/server version skew.

Refresh the MODX cache. Pass partitions (e.g. ['resource','context_settings']) to refresh only those; omit for a full refresh.

Flush cached access permissions (the manager's 'Flush Permissions') so ACL changes apply. ACL write tools already do this automatically; use this for a manual flush.

Read the modxMCP write-audit trail (newest last). Optionally filter to one action.

Run ANY MODX processor directly (escape hatch). Requires the modxmcp.allow_run_processor setting to be enabled. High privilege — prefer a dedicated tool when one exists.

List manager/web users (modUser).

Get a user by id.

Create a user. Pass 'password' to set it explicitly; omit to auto-generate. Profile fields (email, fullname, phone…) are accepted alongside.

Update a user (profile fields, active state).

Delete a user by id.

List contexts (modContext): key, name, description, rank.

Get a context by key.

Create a context. 'key' is the unique identifier (e.g. 'mobile').

Update a context (name/description/rank). 'settings' may be a JSON array of context settings (advanced).

Delete a context by key.

List settings of a context (modContextSetting).

Get one context setting (by context_key + key).

Create a context-level setting (overrides the system setting for that context).

Update a context setting (by context_key + key).

Delete a context setting (by context_key + key).

Install a transport package from a provider (default modx.com) by name, e.g. {package:'MIGX'}. Returns 'already_installed' if present.

Uninstall a transport package by signature (e.g. 'migx-2.13.0-pl').

List transport providers (modx.com and custom, e.g. modstore.pro): id, name, service_url.

Search a provider's catalogue (use before install_package). Defaults to modx.com.

Add a transport provider (e.g. modstore.pro). For paid providers pass username + api_key.

Update a transport provider.

Delete a transport provider by id.

List namespaces (modNamespace): name, path, assets_path.

Create a namespace.

Update a namespace (by name).

Delete a namespace by name ('core' cannot be deleted).

List lexicon entries, filtered by namespace + topic + language (and optional search).

List lexicon topics for a namespace/language.

Create or override a lexicon entry (DB override of the file value).

Revert a lexicon entry — remove its DB override so the file value applies.

List MODX user groups (id, name, parent, rank).

Get a single user group by id.

Create a user group.

Update a user group.

Delete a user group by id.

List members of a user group.

Add a user to a user group, optionally with a role.

Update a user's membership in a group (e.g. change role).

Remove a user from a user group.

List access roles (id, name, authority).

Get a role by id.

Create a role.

Update a role.

Delete a role by id.

List access policies (id, name, description, template).

Get an access policy by id.

Create an access policy.

Update an access policy (e.g. its permissions map).

Delete an access policy by id.

List access policy templates.

Get an access policy template by id.

Create an access policy template.

Update an access policy template.

Delete an access policy template by id.

List permissions defined by a policy template (read-only catalogue).

List resource groups (id, name).

Get a resource group by id.

List resources assigned to a resource group.

Create a resource group.

Update a resource group.

Delete a resource group by id.

Add a resource (document) to a resource group.

Remove a resource (document) from a resource group.

List context-access ACL entries, optionally filtered by usergroup/context/policy.

Grant a user group access to a context with a policy and minimum role authority.

Update a context-access ACL entry by id.

Remove a context-access ACL entry by id.

List resource-group access ACL entries.

Grant a user group access to a resource group with a policy and minimum role authority.

Update a resource-group access ACL entry by id.

Remove a resource-group access ACL entry by id.