Skip to main content
Glama

mat_get_compile_diagnostics

Retrieve compiler diagnostics for a Material asset, including errors, warnings, and expression count, to verify if it compiles cleanly.

Instructions

Get compiler-derived diagnostics for a Material asset.

Args: material_path: Full asset path (e.g. '/Game/Materials/M_DemoB') include_warnings: Include warning-level items (default True)

Returns: StructuredResult with outputs: compile_clean — bool errors[] — structured error items warnings[] — structured warning items expression_count — int compiler_summary — str had_errors — bool

KB: see knowledge_base/32_AGENT_PLAYABLE_SLICE_RECIPE.md#overview Example: mat_get_compile_diagnostics(material_path="/Game/MCP_Test/M_Example")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
material_pathYes
include_warningsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.1/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden, and it does disclose the StructuredResult outputs and the effect of include_warnings. However, it does not explicitly state whether the tool triggers a compile or merely returns already-generated diagnostics, nor does it confirm the operation is side-effect-free/read-only.

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 organized into Args, Returns, KB, and Example sections, with the core purpose front-loaded. There is no filler; every section adds operational value in a compact, scannable format.

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?

The description provides parameter semantics, a detailed return shape, a KB pointer, and a runnable example, which is strong for correct invocation. It is only missing an explicit note on preconditions, such as whether the material must already exist or whether the diagnostics reflect the most recent compilation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, but the description compensates fully: material_path is explained as a full asset path with a concrete example, and include_warnings is described as controlling warning-level items with a default of True. This gives the agent meaningful semantic information beyond the bare schema titles and types.

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 opens with a specific verb and resource: 'Get compiler-derived diagnostics for a Material asset.' This clearly identifies both the action and the target, and distinguishes it from sibling tools like bp_get_compile_diagnostics, which targets Blueprints. The Material-scoped language leaves little ambiguity about what the tool operates on.

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 purpose and example imply the tool is used to inspect a Material's compilation diagnostics, but there is no explicit when-to-use guidance or mention of alternatives such as mat_validate_material, compile_material_and_report, or mat_compile. The KB reference may help, but the description itself does not route the agent away from related tools.

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