Skip to main content
Glama

modx_install_package

Installs a MODX transport package by name from a provider, with optional target signature for controlled update or downgrade. Returns 'already_installed' when the package is present.

Instructions

Install a transport package from a provider (default modx.com) by name, e.g. {package:'MIGX'}. Returns 'already_installed' if present.

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": {
      "package": "<package>"
    },
    "name": "modx_install_package"
  }
}

Input Schema

NameRequiredDescriptionDefault
packageYes
providerNoProvider id (defaults to modx.com).
target_signatureNoOptional exact provider signature for controlled update/downgrade.

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, so the description carries the full burden. It does disclose genuine behavior beyond the schema: the default provider and the 'already_installed' short-circuit result. However, it omits the side effects of installation (does it run the package's setup/upgrade resolver, clear cache, need elevated permissions?) — a notable gap for a mutation tool.

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 compact sentences, front-loaded with the operation and followed by the expected return case. The inline example carries real information rather than padding, and there is no redundant wording.

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 three-parameter mutating installer with no output schema, the description is adequate but incomplete: it explains what gets installed and one failure mode, yet leaves permissions, post-install steps, and the purpose of target_signature unexplained relative to tool complexity.

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 covers 67% of parameters. The description adds value on 'package' by showing it is a name string ('MIGX'), which the schema leaves undescribed. It repeats the schema's provider default and says nothing about target_signature's controlled update/downgrade role, so meaning beyond the schema is partial.

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 ('Install a transport package from a provider') and adds a concrete example '{package:'MIGX'}'. The verb distinction from siblings like modx_uninstall_package and modx_search_packages is implicit in the verb rather than stated, but an agent can still identify the operation immediately.

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 when-to-use guidance beyond the bare operation. It never says to call modx_search_packages or modx_list_providers first to resolve a name or provider id, nor whether the package must be absent. The 'already_installed' note hints at idempotence but is framed as a return value, not usage guidance.

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