Skip to main content
Glama
CarlxsMG

UEAgent

by CarlxsMG
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

get_niagara_user_parameter

Read-onlyIdempotent

Read a Niagara System user-exposed parameter's current value by short name and type, returning the stored value for debugging or round-trip verification.

Instructions

Read a user-exposed parameter's current value from a Niagara System's exposed store. Resolves the parameter by short name (no "User." prefix) and the supplied type token, reads the POD value back. Round-trip companion to set_niagara_user_parameter.

Returns: { system_path: string, parameter_name: string, parameter_type: string, found: bool, value_read_back?: number|bool|[number...] }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNoType token: Float|Vector|Vec2|Vec4|Color|Bool|Int (case-insensitive); defaults to Float
system_pathYesAsset path of the Niagara System.
parameter_nameYesUser parameter name (without the "User." prefix).

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so safety is covered. The description adds real context beyond them: the parameter is looked up in the exposed store by short name plus type token, the value is POD read-back, and a 'found' flag signals lookup failure, which tells the agent how to interpret a miss.

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?

Three tight sentences with the operation front-loaded and the return shape in a compact inline block. Every sentence carries information; the return block is arguably redundant for a text-only read but is efficient and useful.

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?

No output schema exists, but the description enumerates the returned fields including the optional value_read_back and the found flag, and the annotations carry the safety profile. An agent has everything needed to call and interpret the result.

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 all three parameters are already documented in the schema. The description reinforces the no-"User." prefix and type-token requirements but adds no syntax or format detail the schema lacks, so baseline 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?

States a specific verb and resource: 'Read a user-exposed parameter's current value from a Niagara System's exposed store.' It disambiguates from the sibling set_niagara_user_parameter by explicitly framing itself as its round-trip companion, and it names the resolution mechanism (short name plus type token).

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?

Identifies itself as the read counterpart to set_niagara_user_parameter, which gives the agent clear context for when this is the right call. It stops short of explicit when-not conditions or other alternatives (e.g. reading a component parameter directly via get_niagara_component_matrix), so it is clear context but not a full routing guide.

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