Skip to main content
Glama

setup_flip_sim

Build a FLIP fluid simulation network from source geometry in one call, including container, boundary, solver, ground plane, and particle cache.

Instructions

Build a FLIP fluid simulation network from source geometry.

Preferred over manual wiring — builds SideFX's SOP FLIP chain in one call: FLIP Container sized around the source, FLIP Boundary emitting from it, FLIP Solver with a ground plane at y=0, and a File Cache on the particles.

Args: source_geo: Source SOP path. domain: Domain type. particle_sep: Particle separation distance. name: Top-level geo node name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoflip_sim
domainNobox
source_geoNo/obj/geo1/sphere1
particle_sepNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.24.1
    • addedInput schema / additionalProperties
      Added value: +false
  2. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It helpfully discloses the exact SOP chain that will be built (container, boundary, solver, ground plane, file cache), but it does not mention scene mutation, required connection state, permissions, undo behavior, or failure modes, leaving clear gaps.

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?

The description is front-loaded with purpose, then adds the chain details and a clean args list. Every sentence carries useful information with no repetition or filler.

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?

Given no output schema, no annotations, four parameters, and 0% schema description coverage, the description supplies purpose, chain composition, and per-argument meaning. It omits some useful details such as valid domain values, particle separation units, and prerequisites, but an agent can still invoke the tool 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. It lists all four arguments and gives meaning for each, including 'Source SOP path', 'Domain type', 'Particle separation distance', and 'Top-level geo node name'. 'Domain type' remains vague without valid values or defaults, but overall it substantially fills the schema gap.

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 opens with a specific verb and resource: 'Build a FLIP fluid simulation network from source geometry.' It clearly distinguishes this from manual wiring and from sibling sim setups like setup_pyro_sim, setup_rbd_sim, and setup_vellum_sim by naming the FLIP-specific network it creates.

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?

It explicitly says this is 'Preferred over manual wiring' and describes the one-call chain, giving clear context for when to use it. However, it does not explicitly contrast with the other simulation setup tools or state when not to use it, so it stops short of full conditional guidance.

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