Skip to main content
Glama

Publish Interface

publish_interface
Destructive

Record a named interface frame on a component so other parts can mate to it, saving its origin and axes in the component file for later assembly mating.

Instructions

Record a named interface frame on a component so other parts can mate to it — the published "here is where you bolt to me, and how it's oriented".

handle: the component's shaped object. name: interface name (e.g. "lid_seat", "bolt_circle", "bore_axis"). frame: {origin:[x,y,z], z_axis:[...]?, x_axis:[...]?}. z_axis defaults +Z, x_axis +X. Extra keys (e.g. bolt-circle metadata) are stored verbatim.

Persists in the component's .FCStd as a JSON property bag, so merge_assembly can mate against it later. Returns {handle, name, frame, interfaces}.

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": {
      "handle": "<handle>",
      "name": "<name>",
      "frame": "<frame>"
    },
    "name": "publish_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
frameYes
handleYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, and the description usefully adds that state is persisted into the component's .FCStd as a JSON property bag and that extra frame keys are stored verbatim — real behavioral context beyond the annotations. It stops short of stating what happens on a name collision (overwrite vs error), which is exactly the destructive behavior an agent needs to know.

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?

Front-loaded with one sentence of purpose, then a compact parameter block, then persistence and return shape. Each line carries information an agent needs; the only arguably decorative element is the bolt metaphor, which still reinforces the mating purpose.

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?

For a mutating, nested-object tool with no output schema, the description supplies the return shape ({handle, name, frame, interfaces}), storage location, and axis defaults. Remaining gaps are duplicate-name/overwrite semantics and the undocumented workspace parameter.

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 only 25% (only 'workspace' is documented), so the description must compensate and largely does: it defines handle, name (with example values), and frame, including the z_axis/+Z and x_axis/+X defaults and the verbatim-passthrough rule for extra keys that the bare 'object' schema does not convey. The 'workspace' parameter is not explained at all, keeping this from a 5.

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?

Names a specific verb and resource (record a named interface frame on a component) and states the downstream purpose: enabling other parts to mate to it. The phrase 'here is where you bolt to me, and how it's oriented' plus the later mention of merge_assembly makes it distinguishable from read-side siblings like get_interface and from check tools like interface_align_check.

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

Usage Guidelines3/5

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

The description conveys context (published interfaces are consumed later by merge_assembly), which implies when to call it, but there is no explicit when-to-use/when-not guidance, no prerequisite statement (an open component/document, a valid handle), and no naming of the alternative to use when you only want to read an interface.

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