Skip to main content
Glama

set_niagara_data_interface_default

DestructiveIdempotent

Set a Niagara data interface property from a text value, then recompile and save the system. Works with any type the property's ImportText parses.

Instructions

Writes one property of a user-parameter data interface on a Niagara system from text parsed by the property's ImportText, so any type it accepts works ("1.5", "(X=1,Y=2,Z=3)", "(R=1,G=0,B=0,A=1)", an enum name), inside an undo transaction, then requests a system recompile and saves the system; success requires the save. A missing DI or property, or text that does not parse, is an error and the DI is left untouched. value echoes the request; value_read_back is the stored value exported as text. List the DI's properties with get_niagara_data_interface_info; for asset references use set_niagara_data_interface_asset.

Returns: { system_path: string, parameter_name: string, property_name: string, value: string, value_read_back: string, set: bool, saved: bool, save_error?: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
valueYesString representation of the value (parsed by FProperty::ImportText_Direct)
system_pathYesAsset path of the Niagara System.
property_nameYesName of the FProperty on the DI to set
parameter_nameYesShort name of the user-parameter DI to mutate

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedInput schema / required
      Previous value: -[
      -  "parameter_name",
      -  "property_name",
      -  "value"
      -]New value: +[
      +  "system_path",
      +  "parameter_name",
      +  "property_name",
      +  "value"
      +]
  2. First observedv1.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover safety (readOnly=false, destructive=true, idempotent=true), and the description adds substantial context beyond them: it runs inside an undo transaction, requests a system recompile and saves the system, success requires the save, and on failure the DI is left untouched. It even explains the return semantics of value vs value_read_back.

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-loaded with the core action and the returns are listed compactly at the end. However the opening sentence is very long with nested clauses and parenthetical examples, making it slightly hard to scan; it earns its content but could be split.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, when-to-use, side effects, error behavior, and inline return shape for a mutation tool with no output schema. An agent has everything needed to invoke it correctly and interpret the result.

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 100% so baseline is 3, but the description adds real meaning for value: it is text parsed by the property's ImportText and works for any accepted type, with concrete examples ("1.5", "(X=1,Y=2,Z=3)", "(R=1,G=0,B=0,A=1)", enum name). This compensates for the format ambiguity the schema leaves open.

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 (writes one property) on a specific resource (user-parameter data interface on a Niagara system), and explicitly distinguishes itself from set_niagara_data_interface_asset (asset references) and points to get_niagara_data_interface_info for listing properties.

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

Usage Guidelines5/5

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

Gives explicit routing: use get_niagara_data_interface_info to list properties, use set_niagara_data_interface_asset for asset references. Also states the success precondition (save must succeed) and the error condition (missing DI/property or unparseable text).

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