Skip to main content
Glama

sample_volume

Read volume fields at specified world positions or from another SOP's points to return per-point values and summary statistics for analysis.

Instructions

Read named volume fields at world positions, or at another SOP's points.

"What does the collision SDF read where the particles are" is one call with from_node, and adds no node to the scene. A VDB SDF reads its background (the band width) outside its narrow band, not the distance.

Args: node_path: SOP holding the volumes. fields: Volume names (the name attribute), e.g. ["density"]. positions: [[x, y, z], ...] in world space. from_node: SOP whose points are the positions, instead of positions. limit: Values are returned up to this many positions; the summary always is. bins: Histogram bin count, or a list of bin edges, for the summary. threshold: Count the samples above this value.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
binsNo
limitNo
fieldsYes
from_nodeNo
node_pathYes
positionsNo
thresholdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.24.1

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations the description carries the full burden, and it does disclose non-obvious behavior: the VDB SDF returns its background (band width) outside the narrow band rather than true distance, and the call 'adds no node to the scene'. It omits return-shape and any cost/performance context, so it is strong but not exhaustive.

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?

Front-loads the core capability in one sentence, follows with a motivating example, then a compact Args list — every block earns its place. The example sentence is slightly convoluted but the structure is sound.

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 7-parameter tool with no annotations and no output schema, the definition covers purpose, usage scenario, side effects, and every input's meaning. It hints at the summary (limit/bin/threshold) but never describes the actual return structure, which is the one remaining gap given no output schema exists.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/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 its Args block documents all seven parameters with real meaning: fields as the 'name' attribute, positions in world space, from_node overriding positions, limit applying to values but never the summary, bins as count-or-edges, and threshold as an above-value count. This fully bridges 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?

States a specific verb and resource ('Read named volume fields') plus the two supported point sources ('at world positions, or at another SOP's points'). This cleanly separates it from sample_geometry and compare_volumes without the agent opening 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?

Provides a concrete scenario ('what does the collision SDF read where the particles are') mapped to a specific parameter (from_node), and clarifies the from_node-vs-positions choice. It stops short of naming when NOT to use it or pointing to get_volume_info / compare_volumes as alternatives.

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