Skip to main content
Glama

get_blackboard_keys

Read-onlyIdempotent

List blackboard key definitions and key counts from an editor-world actor or UBlackboardData asset, returning names, types, and sync flags for AI behavior inspection.

Instructions

List blackboard key definitions (name, type, instance_synced, base_class or enum subsettings): of the running blackboard of an editor-world actor when actor_name is given, else of the UBlackboardData asset at blackboard_path. Read-only; returns keys and key_count. Editor world only, never PIE.

Returns: { actor_name: string?, blackboard_asset: string?, keys: [{ name: string, type: string, instance_synced: bool }], key_count: number }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actor_nameNoObject name or label of an editor-world actor whose live blackboard to read; takes precedence over blackboard_path.
blackboard_pathNoPath to a UBlackboardData asset (alternative to actor_name)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedInput schema / properties / actor_name / description
      Previous value: -"Name of the actor whose blackboard to enumerate (optional, use blackboard_path for asset-based read)"New value: +"Object name or label of an editor-world actor whose live blackboard to read; takes precedence over blackboard_path."
  2. First observedv1.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive/openWorld=false. The description adds genuinely new context beyond them: 'Editor world only, never PIE', plus the precedence rule between the two source modes and the returned key_count. That is useful behavioral scoping, though nothing about failure modes when neither selector is supplied.

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 verb and resource, then the conditional source, then constraints and return shape. Dense but every clause carries information; the parenthetical field list is slightly crammed into one long sentence, which costs a little readability.

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?

With no output schema, the description helpfully spells out the return object (actor_name/blackboard_asset/keys/key_count) and the editor-world-only constraint. It covers both invocation modes adequately; only the sibling overlap and missing-behavior case are left unaddressed.

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% and both parameters are documented in the schema, including the actor_name precedence note. The description largely restates the schema's precedence rule, adding only the per-key field list, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List blackboard key definitions') and enumerates the fields returned (name, type, instance_synced, base_class or enum subsettings). It also distinguishes the two read modes (live actor blackboard vs UBlackboardData asset). However, it does not differentiate itself from the close sibling get_blackboard_keys_asset, which on its face covers the same asset-read case, leaving some overlap ambiguity.

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?

Gives conditional guidance ('when actor_name is given, else ... at blackboard_path') and the environment constraint 'Editor world only, never PIE'. But it never says when to prefer this tool over the sibling get_blackboard_keys_asset or get_blackboard_value, so alternative selection is left to inference.

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