Skip to main content
Glama

modx_clear_cache

Refresh the MODX cache to apply changes, optionally clearing only specified partitions for targeted updates.

Instructions

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

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_clear_cache"
  }
}

Input Schema

NameRequiredDescriptionDefault
partitionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations present, the description carries the whole burden. It discloses that omitting partitions performs a full refresh, which is the key behavioral distinction, but says nothing about whether cache clearing has side effects, requires permissions, or briefly degrades site performance.

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

Conciseness5/5

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

Two short sentences with the primary action first and the parameter detail second. No filler and no repetition of the tool name.

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

Completeness3/5

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

For a one-optional-parameter tool with no output schema this covers the essentials, but the unspecified set of valid partition values is a real gap an agent would hit on first use. Permission requirements and any post-clear effects are also unaddressed.

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 0%, so the description must compensate. It does explain the parameter's role, gives an example value list, and states the omit-means-full-refresh default, but never enumerates the valid partition names, so an agent must guess at supported values.

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

Purpose4/5

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

States a specific verb and resource ('Refresh the MODX cache'), which an agent can immediately understand. It does not distinguish itself from the sibling modx_virtualpage_clear_cache, leaving mild ambiguity about which cache each targets.

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

Usage Guidelines3/5

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

Explains the two modes of calling it (partitions vs. omit for full refresh), which is usage guidance for the parameter. It never says when to prefer this over the sibling cache-clearing tool or what situations call for a partial vs. full refresh.

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