Skip to main content
Glama

add_ai_stimuli_source

Idempotent

Adds a UAIPerceptionStimuliSourceComponent to an actor and registers it for an AI sense like Sight, Hearing, or Damage. Idempotent: reruns return the existing component.

Instructions

Adds a UAIPerceptionStimuliSourceComponent to an actor and registers it as a source for the supplied AISense (default Sight). Idempotent: re-run returns the existing component.

Returns: { actor_name: string, component_name: string, sense: string, registered: bool, already_existed: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
senseNo"Sight" | "Hearing" | "Damage" (default "Sight")
actor_nameYesDisplay label or internal name of the target editor-world actor (required)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-destructive, idempotent behavior. The description goes beyond them by explaining idempotency concretely ('re-run returns the existing component') and by listing the returned fields, which is valuable since no output schema exists.

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 two front-loaded sentences plus a compact return-shape line. Every part earns its place: purpose first, idempotency second, return contract third.

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 simple two-parameter mutation tool with rich annotations, the description is nearly complete. It covers purpose, idempotency, and return values, though it could mention prerequisites such as the actor being in an editor world or the AI perception system needing to be active.

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 both parameters are already documented with types and defaults. The description restates the default sense ('Sight') but adds no syntax, constraints, or interpretation beyond the schema, making the baseline 3 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 uses a precise verb-resource pair: it adds a UAIPerceptionStimuliSourceComponent to an actor and registers it for a supplied AISense. The component class and registration behavior are specific enough to distinguish this from adjacent AI-perception tools such as add_ai_perception_sense.

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 description implies the usage context: setting up an actor to be perceived by an AI sense, with Sight as the default. It does not explicitly state when to choose this tool over alternatives or when not to use it, so the guidance remains implied rather than explicit.

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