Skip to main content
Glama

modx_migx_get_config

Retrieves a full MIGX configuration by ID, including form tabs, columns, buttons, filters, and permissions as stored JSON strings, so you can inspect or reuse its settings.

Instructions

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

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": {
      "id": "<id>"
    },
    "name": "modx_migx_get_config"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description must carry the behavioral burden. It does add real value by disclosing that the config sections come back as stored JSON strings, which implies callers must parse them, but it says nothing about permissions needed, whether a missing id errors or returns null, or how large the payload can be.

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?

One front-loaded sentence, no filler, and the parenthetical field list is dense with useful information rather than padding.

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

Completeness4/5

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

For a simple one-parameter read tool with no output schema, the description does the necessary work of sketching the return shape and flagging the JSON-string encoding. Only the error/not-found behavior remains undocumented.

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 coverage is 0% on the single required `id` parameter. The description ties it to a MIGX configuration id, which is the minimum useful disambiguation, but adds no format, type, or lookup guidance beyond the schema's own typing.

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 ("Get a full MIGX configuration by id") and enumerates the contents (formtabs, columns, buttons, filters, permissions). It is clearly distinguishable from create/update/delete siblings, though it does not explicitly contrast with modx_migx_list_configs.

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?

The phrase "by id" implies this is the single-record retrieval path and that listing is done elsewhere, but no alternative is named and no prerequisites or when-not conditions are given. Usage is inferable rather than stated.

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