Skip to main content
Glama

Sync addon

sync_addon
Destructive

Trigger a sync for an addon to apply any pending changes from the source repository.

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": {
      "addon_name": "<addon_name>",
      "cluster_id": "<cluster_id>"
    },
    "name": "sync_addon"
  }
}

Input Schema

NameRequiredDescriptionDefault
pruneNoIf true, prune resources that are no longer defined.
addon_nameYesName of the addon to sync.
cluster_idYesAnkra cluster id (UUID) the call targets. Discover ids with list_clusters.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered structurally. The description confirms that source-repository changes get applied but adds no operational context such as whether the call is synchronous, what happens to resources removed upstream, or how the prune flag interacts with destruction.

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 well-formed sentence with the action and its effect front-loaded and no wasted wording. It is efficient, though its brevity leaves the behavioral gaps noted elsewhere.

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?

This is a destructive mutation with no output schema, and the description says nothing about the result (execution/job handle, timing, whether follow-up like wait_for_execution is needed) or about permissions. For a destructive tool, that is a notable gap.

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 100%: every parameter, including prune and the UUID cluster_id with a pointer to list_clusters, is documented in the schema itself. The description adds no meaning beyond that, so the baseline of 3 applies.

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 ('trigger a sync') and resource ('an addon'), plus the effect ('apply any pending changes from the source repository'), which distinguishes it from read-only siblings like get_addon_status or list_addons.

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 phrase 'apply any pending changes' hints at the situation, but there is no explicit when-to-use guidance, no exclusions, and no mention of alternatives such as sync_helm_registry or rollback_addon for reverting instead of applying.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.