Skip to main content
Glama

modx_clientconfig_get_setting

Retrieve a MODX ClientConfig setting by its ID or key to read configuration values for your site.

Instructions

Get a ClientConfig setting by id or key.

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

Input Schema

NameRequiredDescriptionDefault
idNo
keyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.7/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 and adds nothing: it does not say what happens when the setting is not found, which of id/key wins if both are passed, or whether sensitive values (ClientConfig settings often hold API keys/secrets) are returned in plaintext. For an unannotated lookup tool this is a meaningful gap.

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; it is efficient but so terse that the brevity comes at the cost of specification rather than from tight editing of richer content.

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?

A read tool with no annotations, no output schema, and 0% schema coverage needs the description to explain the returned shape and failure behavior. Neither is covered, so an agent cannot predict the response or error handling.

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%, so both parameters are undocumented in structured data. The phrase 'by id or key' hints at the two lookup modes but does not state that they are alternatives, whether either is required, or the precedence when both are supplied.

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 ClientConfig setting') and names the lookup modes (id or key), which distinguishes it from the clientconfig list/create/update/delete siblings. It does not, however, explicitly distinguish itself from other 'get' style tools or say what a ClientConfig setting contains.

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

Usage Guidelines2/5

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

No guidance on when to use this versus modx_clientconfig_list_settings, and no stated prerequisite such as needing a known id or key first. Nothing tells the agent how to obtain a valid identifier before calling.

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