Skip to main content
Glama

embed_manual_in_3mf

Embed an assembly manual PDF and signed manifest into an existing 3MF file, writing an augmented copy to a chosen path so the print file carries its own build instructions.

Instructions

Augment a 3MF with the assembly manual + signed manifest (Business+).

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": {
      "threemf_path": "<threemf_path>",
      "output_path": "<output_path>"
    },
    "name": "embed_manual_in_3mf"
  }
}

Input Schema

NameRequiredDescriptionDefault
pdf_pathNoThe manual PDF to embed when no ``manual_id`` is given. One of the two is required.
manual_idNoThe manual revision to embed, from manual history. When given it wins: the PDF, ``spec.json`` and any release recorded with it are used, and ``pdf_path`` / ``spec_json_path`` are ignored.
release_idNoOptional signed release whose manifest to embed. A release recorded on the ``manual_id`` revision takes precedence; the response says when no manifest went in.
output_pathYesWhere to write the augmented .3mf.
threemf_pathYesThe existing .3mf to augment.
spec_json_pathNoOptional ``spec.json`` to embed with ``pdf_path``. Omitted or unreadable, an empty spec is embedded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.5.1
    • addedInput schema / properties / manual_id / description
      Added value: +"The manual revision to embed, from manual history. When given it wins: the PDF, ``spec.json`` and any release recorded with it are used, and ``pdf_path`` / ``spec_json_path`` are ignored."
    • addedInput schema / properties / output_path / description
      Added value: +"Where to write the augmented .3mf."
    • addedInput schema / properties / pdf_path / description
      Added value: +"The manual PDF to embed when no ``manual_id`` is given. One of the two is required."
    • addedInput schema / properties / release_id / description
      Added value: +"Optional signed release whose manifest to embed. A release recorded on the ``manual_id`` revision takes precedence; the response says when no manifest went in."
    • addedInput schema / properties / spec_json_path / description
      Added value: +"Optional ``spec.json`` to embed with ``pdf_path``. Omitted or unreadable, an empty spec is embedded."
    • addedInput schema / properties / threemf_path / description
      Added value: +"The existing .3mf to augment."
  2. Addedv1.5.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already disclose that this is a non-read-only but non-destructive, closed-world operation, so the baseline burden is lower. The description adds real value with the signed-manifest payload and the Business+ entitlement gate, but it leaves open questions an agent would care about: does it overwrite an existing output file, what happens on a missing or unreadable manual, and what does a successful run report.

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?

One short sentence, front-loaded with the verb and target, with the payload and the tier constraint packed in and no filler. Nothing redundant to trim, though the extreme brevity is also the source of the completeness gap.

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 six-parameter file-writing operation with no output schema, the description is minimal: the schema carries all parameter semantics, but return behavior, failure modes, and overwrite semantics are entirely undocumented. It is adequate to identify the tool but not to predict what a call will do in edge cases.

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% and the property descriptions already explain the manual_id-over-pdf_path precedence and the release_id manifest behavior in detail. The tool description adds no parameter-level meaning beyond naming 'manual' and 'manifest', 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?

The description gives a specific verb ('Augment') and resource ('a 3MF') plus the exact payload: the assembly manual and a signed manifest. That is clearly distinguishable from generic 3MF writers like export_model_3mf or wrap_gcode_as_3mf, though it never names a sibling such as generate_assembly_manual, so differentiation is implied rather than stated.

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 only gating signal is '(Business+)', which tells the agent about a tier precondition, but there is no guidance on when to reach for this tool versus generating a manual first or exporting a 3MF another way. Nothing in the description says what must exist beforehand (a manual revision or a PDF) even though the schema requires one of them.

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