Skip to main content
Glama

find_actors_by_name

Read-onlyIdempotent

Locate actors by substring in internal name or editor label to get name, label, class, and transform. Use when you know what it's called, not its class.

Instructions

Locate actors by a SUBSTRING of their internal name and/or their editor label, returning name, label, class and transform for each hit. This is the one to use when you know what a thing is CALLED but not its class -- get_actors_by_class needs an exact class name, and this one alone can search labels (match='label'), which is where hand-assigned names live. Plain case-INSENSITIVE substring, no wildcards and no regex: 'turret' matches BP_Turret_C_2, and '*' matches literally nothing. Its world selector is the canonical one: 'editor' (default), 'pie'/'game', 'server', 'client' and 'pie:N' all resolve for real, an unrecognised value FAILS instead of falling through to the editor world, and the reply stamps world_package/world_type/net_mode/pie_instance so you can tell which world answered.

Returns: { matching_actors: [ { name, actor_name, label, class, location, rotation, scale, is_loaded } ], matching_actors_count: int, search_pattern: string, match: string, results_truncated: bool, max_results: int, world: string (the normalized selector that resolved), world_name: string, world_package: string (in World Partition the UEDPIE_N prefix lives HERE, not in world_name), world_type: string, net_mode: string, pie_instance: int }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
matchNoOptional 'name' | 'label' | 'both' (default 'both'). 'name' = internal object name only; 'label' = the editor label from the outliner; 'both' = a hit on either. An unknown value is a clean error.
worldNoOptional world selector: absent/'editor' (default) | 'pie' (ambiguous: PlayWorld, else the first PIE context) | 'game' (alias of 'pie') | 'server' (the PIE world with authority, GetNetMode() != NM_Client) | 'client' | 'pie:N' (the PIE context whose PIEInstance is N). Case-insensitive; an unrecognised value is a clean error listing the worlds present, never a silent fallback to the editor world.
patternNoSubstring to look for, case-insensitive, no wildcards or regex. Cannot be empty.
max_resultsNoOptional cap on hits (default 1000); results_truncated says whether the scan stopped early.
name_patternNoAlias of `pattern` (same value, same meaning). Accepted because sibling tools spell this parameter differently; prefer `pattern`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations cover safety (readOnly/idempotent/non-destructive), so the description adds value by disclosing matching quirks ('*' matches literally nothing), the fail-fast world selector behavior (unrecognised value FAILS instead of falling through to the editor world), and truncation stamping. It could still say more about ordering or scan cost, but the behavioral context is well above the annotation bar.

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 purpose, then alternatives, then matching/world caveats, then returns. Dense but information-rich; a few sentences (world selector details) duplicate the schema, which is the only real slack.

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?

There is no output schema, and the description compensates by enumerating the full return shape, including world_package/world_type/net_mode/pie_instance stamps and the World Partition UEDPIE_N note. Combined with 100% parameter coverage, nothing needed to call it correctly is missing.

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 coverage is 100% and the schema already spells out the enums, world selectors, case-insensitivity, no-wildcards rule and max_results default. The description largely restates those same facts, adding only marginal framing such as labels being where hand-assigned names live, so the 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 ('Locate actors by a SUBSTRING of their internal name and/or their editor label') plus the return payload. It explicitly distinguishes itself from the sibling get_actors_by_class, so an agent can route without opening either schema.

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 an explicit when-to-use rule ('when you know what a thing is CALLED but not its class') and names the alternative, get_actors_by_class, along with the reason it does not fit (needs an exact class name). It also flags the unique match='label' capability.

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