Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

get_niagara_module_input

Read-onlyIdempotent

Read a Niagara module input override to check its real type and current rapid-iteration value; returns found=false when no override exists.

Instructions

Read a Niagara module input override from the rapid-iteration store. Locates the module function-call node and the named input, reports the input's real type, and reads back any rapid-iteration override currently set for it. found=false means no override exists yet (the module is using its script default); in that case 'value' is omitted.

Returns: { system_path: string, emitter_name: string, module_node_name: string, input_name: string, ri_param_name: string, value_type: string, found: bool, value?: number | [number, number, number] | [number, number, number, number], success: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
input_nameYesLeaf name of the module input (e.g. "Drag").
system_pathYesAsset path of the Niagara System.
emitter_nameYesDisplay name of the emitter handle.
module_node_nameYesThe module function-call node name.

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

A4.3/5.0
Behavior5/5

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

Although annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, the description adds meaningful behavioral context: it locates the module function-call node and named input, reports the input's real type, and explains that found=false means no override exists and 'value' is omitted. This goes well beyond what the annotations provide.

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 the core purpose, then adds the important found=false edge case, followed by a concise Returns block. Every part earns its place, especially since no output schema exists to document the return shape.

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?

For a read-only tool with rich annotations, full schema coverage, and no output schema, the description is complete: it explains the operation, the found=false behavior, and the return fields. An agent has enough information to invoke and interpret the tool correctly.

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 description coverage is 100%, so the schema already documents all four parameters. The description does not add syntax, format, or interpretation details beyond what the schema provides, so the baseline score of 3 is appropriate.

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 states a specific verb and resource: 'Read a Niagara module input override from the rapid-iteration store.' It also distinguishes this read operation from the sibling write tool set_niagara_module_input by making clear it retrieves existing override data rather than modifying it.

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

Usage Guidelines3/5

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

The tool's purpose implies when to use it, but the description does not explicitly state when to choose it over alternatives or name any sibling tools. It also does not describe prerequisites or conditions beyond the basic read context.

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