Skip to main content
Glama

Show the definition of one object

patchwork_show
Read-onlyIdempotent

Returns the definition of a FileMaker object, such as a script, layout, or field, as editable text or XML for reading and replacing.

Instructions

Return the definition of one object, to read it or to edit it and send it back. A script comes as FileMaker text, one step per line, ready for patchwork_set_steps. Any other kind comes as its Save-as-XML block, ready for patchwork_replace. kind=step returns the XML of a real step of that name found in the file, as a model for steps the text form cannot write. Fails with 'not found' on an unknown name: get exact names from patchwork_list.

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": {
      "kind": "<kind>",
      "name": "<name>"
    },
    "name": "patchwork_show"
  }
}

Input Schema

NameRequiredDescriptionDefault
xmlNoFor a script only: return its XML instead of FileMaker text.
kindYesKind of object. 'step' is a script step type such as Set Field, not an object of the file.
nameYesExact name of the object. Table::Field for a field, the step name (e.g. 'Set Field') for a step.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare this a safe, idempotent read, and the description goes further by disclosing the return format per kind (text vs XML block) and the error behavior on an unknown name. It also explains the non-obvious kind=step behavior: it returns an existing real step from the file as a model rather than an object definition.

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?

Compact and front-loaded, with the core purpose stated first and the per-kind return behavior and error case following. The opening clause 'to read it or to edit it and send it back' is slightly loose but does motivate the tool's role.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description must carry return-value semantics, and it does for every kind. Error behavior, the step special case, and the handoff targets are all covered, leaving nothing an agent needs before calling it.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema: kind=step is framed as a template-gathering mode, and the text/XML return distinction clarifies the practical effect of the xml flag. The 'Table::Field' qualifier is left to the schema, which is fine given full coverage.

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 ('Return the definition of one object') and immediately ties it to a workflow: read, or edit and send back. It is clearly distinguished from the list/replace/set_steps siblings by describing what it returns rather than what it changes.

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 is given: scripts come back as FileMaker text for patchwork_set_steps, other kinds as Save-as-XML blocks for patchwork_replace, and patchwork_list is named as the source of exact names. The failure case ('not found' on an unknown name) tells the agent what to do differently on error.

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