Skip to main content
Glama

modx_get_site_state

Retrieve the authoritative MODX site revision and atomic precondition capability to verify current state before making safe changes.

Instructions

Read the connector-authoritative site revision and atomic-precondition capability used by Site Agent Runtime.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the behavioral burden. It signals a read-only operation and identifies the data as connector-authoritative, but it does not describe authentication requirements, error behavior, return shape, or whether the read has any side effects; for a zero-parameter read tool this is adequate but not rich.

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?

The description is a single front-loaded sentence with no redundant wording. Its compactness is appropriate, though the specialized terminology slightly reduces immediate clarity.

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?

The description names the two pieces of data returned, site revision and atomic-precondition capability, which partially compensates for the absence of an output schema. However, it does not clarify the return structure or the exact conditions under which an agent should rely on this state, leaving some ambiguity for a runtime-oriented tool.

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

Parameters4/5

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

The tool has zero parameters, so there is no parameter meaning for the description to add beyond the empty schema. The baseline for a no-parameter tool is 4.

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?

The description states a specific verb, 'Read', and a specific resource, 'site revision and atomic-precondition capability', which distinguishes it from the many CRUD and list siblings. The domain-specific wording ('connector-authoritative', 'atomic-precondition capability') is somewhat opaque, but an agent can still identify this as a read-only site-state inspection tool.

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?

The only usage context is that the state is 'used by Site Agent Runtime', which does not tell an agent when to call this tool, when not to call it, or which sibling to use instead. There are no explicit preconditions or alternatives.

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