Skip to main content
Glama
U-C4N
by U-C4N

Insert Block Reference

entity_create_block_ref

Insert a block reference instance into a drawing using an existing block definition. Validates the name first, rejecting undefined or layout blocks before any write.

Instructions

Insert a block reference (instance of an existing block definition).

Refused before any write, on both engines: a name that is not a block definition in this drawing (block 'X' is not defined — check block_list), a layout block (*Model_Space / *Paper_Space, a reference cycle) and a non-string name. The same gate as block_insert; this tool is the no-attributes form.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
xYesInsertion X
yYesInsertion Y
nameYesBlock definition name (must exist in drawing)
layerNoLayer name
scale_xNoX scale factor
scale_yNoY scale factor
rotationNoRotation angle in degrees

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.4.0

TDQS

A4.1/5.0
Behavior4/5

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

With only readOnlyHint=false available, the description adds meaningful behavior: it enumerates the refusal conditions enforced before any write (undefined block name, layout blocks *Model_Space/*Paper_Space, non-string names) and quotes the exact error text. It does not cover how layer/scale/rotation are applied, so not a full 5.

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 the core action in one sentence, then the failure conditions. The heavy backtick/parenthetical style is slightly dense but each clause carries real information, so it stays efficient.

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?

An output schema exists so return values need not be described, and the description supplies the missing piece for a mutation tool: the pre-write validation gate. Coverage of mutation semantics and sibling routing is strong, with only the parameter-level behavior of layer/scale/rotation 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%, so all seven parameters are already documented in the schema. The description reinforces that name must reference an existing block definition but adds no format or syntax detail beyond the schema; baseline 3 applies.

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 ('Insert a block reference') and immediately defines it as an instance of an existing block definition. It explicitly distinguishes itself from the sibling block_insert by being 'the no-attributes form', so an agent can differentiate without opening schemas.

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?

Points to block_list as the way to verify a valid name and clarifies the relationship to block_insert. It gives clear context but stops short of an explicit 'use block_insert instead when attributes are needed' routing rule.

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