Skip to main content
Glama

Apply a hand-written FMUpgradeTool patch

patchwork_push
Destructive

Apply a hand-written FMUpgradeToolPatch when no specific tool covers a change, creating a new reversible version; entirely skipped patches are refused.

Instructions

Apply a hand-written FMUpgradeToolPatch. A last resort for changes no other tool covers: prefer the specific tools, which check their result object by object. Here only a patch that FMUpgradeTool skipped entirely is detected and refused. Makes a new version; patchwork_undo reverses it.

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": {
      "patch_xml": "<patch_xml>"
    },
    "name": "patchwork_push"
  }
}

Input Schema

NameRequiredDescriptionDefault
dry_runNoOnly write the patch file to .patchwork/ and return its path. Nothing is applied, no version is made.
messageNoWhat this change does, kept in the version log. Default: a short description of the change.
patch_xmlYesA full patch as XML, with the root element <FMUpgradeToolPatch>.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the destructiveHint/readOnlyHint annotations, it discloses two things the annotations cannot: validation is weaker here (only a patch FMUpgradeTool skipped entirely is detected and refused, versus object-by-object checks in specific tools), and the operation creates a new version that patchwork_undo reverses. That is the exact risk profile an agent needs before committing a destructive write.

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?

Four short sentences, front-loaded with the verb and the fallback ranking, and every sentence carries a routing or risk fact. The clause "only a patch that FMUpgradeTool skipped entirely is detected and refused" is slightly tangled and costs a re-read, which keeps it from a 5.

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?

With annotations covering the safety profile and full schema coverage on all three parameters, the description supplies the remaining essentials: purpose, fallback rationale, weaker validation, versioning, and the undo counterpart. The only omission is what a successful apply returns or what failure looks like, which is a minor gap for a no-output-schema tool.

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 description coverage is 100%, so patch_xml, dry_run, and message are already fully documented in the schema, including dry_run's write-file-only behavior. The description adds no format, sizing, or content guidance for patch_xml beyond what the schema states, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Apply a hand-written FMUpgradeToolPatch") and immediately positions it against the sibling tools that do the same job object by object. An agent can tell from the description alone that this is the escape-hatch path for edits no structured tool handles.

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

Usage Guidelines5/5

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

Explicit routing guidance: "A last resort for changes no other tool covers: prefer the specific tools" tells the agent when NOT to use it, and the undo sentence names the reversal path (patchwork_undo). That is when/when-not plus an alternative in two sentences.

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