Skip to main content
Glama

setup_vellum_sim

Build a complete Vellum simulation network for cloth, hair, grain, or softbody—configure node, solver, and I/O cache—in one call instead of manual DOP wiring.

Instructions

Build a Vellum simulation network with configure node and solver.

Preferred over manual DOP wiring — builds the entire Vellum network in one call: the shelf's Configure recipe for the type, the Vellum Solver, and a Vellum I/O cache that keeps constraints and collisions with the geometry. Use Vellum Drape SOP to let cloth settle before the main simulation.

Args: geo_path: Source geometry object path. sim_type: Simulation type ("cloth", "hair", "grain", "softbody"). substeps: Solver substeps. name: Top-level geo node name. ground: Turn on the solver's ground plane at y=0.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNovellum_sim
groundNo
geo_pathNo/obj/geo1
sim_typeNocloth
substepsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.24.1
    • addedInput schema / additionalProperties
      Added value: +false
  2. Changed1 schema field changedv2.21.0
    • addedInput schema / properties / ground
      Added value: +{
      +  "default": true,
      +  "title": "Ground",
      +  "type": "boolean"
      +}
  3. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose meaningful composition details (the Configure recipe, solver, and I/O cache that preserves constraints and collisions), but says nothing about whether it creates new nodes versus overwriting existing ones, where nodes are placed, idempotency, or undo behavior.

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?

The purpose and the preferred-over rationale are front-loaded, and the component list and follow-up tip are compact. The bullet text and the Args list restate some of the same concepts, so it is slightly redundant but still efficient overall.

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 moderately complex network-building tool with no output schema, the description covers what gets built, all arguments, and a sensible follow-up step. It stops short of stating the resulting node path or return value, but otherwise gives an agent enough to call it correctly.

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 description coverage is 0%, so the description must compensate, and it largely does: all five args are documented, including the valid sim_type values ('cloth', 'hair', 'grain', 'softbody') that the schema omits as an enum, and the ground flag's meaning ('turn on the solver's ground plane at y=0'). Only substeps ('Solver substeps') is described thinly.

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?

The description names a specific verb and resource — 'Build a Vellum simulation network' — and immediately enumerates the components created (Configure recipe, Vellum Solver, Vellum I/O cache). This clearly distinguishes it from the sibling setup_pyro_sim, setup_rbd_sim, and setup_flip_sim without needing to open any schema.

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

Usage Guidelines4/5

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

'Preferred over manual DOP wiring — builds the entire Vellum network in one call' gives explicit context for when to choose this tool over the manual alternative. It also adds a follow-up recommendation (use Vellum Drape SOP to let cloth settle), but does not state when-not-to-use cases such as an existing sim or an already-configured network.

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