Skip to main content
Glama
Sign In
MODX MCP

MODX MCP

by rumata-estor
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

modx_project_overview

Orient on an unfamiliar MODX site in one compact call: retrieve structure, template-to-TV maps, resource counts, contexts, categories, and a shallow tree without loading content.

Instructions

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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "modx_project_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionsNoSubset of sections to return (default: all).
max_tree_nodesNoMax root resources in resource_tree (default 50).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are supplied, so the description carries the full burden, and it does disclose the key traits: it is a read-only structural summary, it returns counts rather than content, and the payload stays bounded on huge sites ('100k resources return the same small payload'). It stops short of stating permissions or exactly how truncation of the tree manifests, but the operational profile is clear.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose and the cost/payload guarantee, then the alternative, then parameters — a sensible order with little waste. It is dense and typographically noisy (all-caps 'COUNTS', the ↔ glyph), which costs it a point.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, and the description compensates by enumerating the returned sections precisely, matching the enum values in the schema. For a two-parameter read tool this is everything an agent needs to call it correctly and interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented, including defaults. The description adds only intent ('fetch only some parts', 'caps the tree roots') beyond the schema, which is the baseline 3 case.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and scope ('Orient on the whole installed site in ONE compact, cheap call') and enumerates what it returns: template↔TV map, counts, shallow tree, categories, contexts, integrations. It explicitly distinguishes itself from list_resources / list_elements, so an agent can route correctly without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit trigger ('Call this FIRST when starting on an unfamiliar project') and an explicit alternative ('for per-item browsing use list_resources / list_elements'). The when-to-use and when-not-to-use are both present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools