Skip to main content
Glama

modx_get_component_files

List files and folders inside an installed MODX component by name, optionally filtering by path or scope. Use it to inspect component structure and locate files before making changes.

Instructions

List files and folders inside an installed MODX component.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
nameYes
pathNo
scopeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden, yet it only implies a read-only listing. It does not say whether the listing is recursive, how deep it goes, whether it can be called on uninstalled components, or what permissions are required — all relevant for a filesystem-facing tool.

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?

A single front-loaded sentence with no filler or redundancy. Its brevity is efficient, though it borders on under-specification given the undocumented parameters.

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

Completeness2/5

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

For a three-parameter tool with no annotations, no output schema, and zero schema descriptions, the definition is far too thin. An agent cannot tell what the returned entries look like (folders vs files, relative paths) or how 'scope' changes the result set.

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

Parameters2/5

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

Schema description coverage is 0% across three parameters, so the description must compensate and does not. It never explains that 'name' is the component identifier, that 'path' is a starting subdirectory, or what the 'core'/'assets'/'all' enum values actually select — leaving the most ambiguous parameter (scope) entirely undefined.

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 ('List') and resource ('files and folders') constrained to an installed MODX component, which distinguishes it from modx_list_installed_components (lists components themselves) and modx_read_component_file (reads one file's content). It stops short of naming those siblings explicitly, so it is clear but not fully differentiated.

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?

Usage is implied by the phrase 'inside an installed MODX component' — an agent can infer it should call this after identifying a component and before reading a specific file. However, no alternative is named and no condition (e.g. 'use modx_read_component_file to read contents') is given.

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