Skip to main content
Glama

pcb_set_plane_net

Assigns an internal plane layer to an existing net so the plane copper connects to that net, rather than relying on a polygon pour.

Instructions

Tie an internal plane layer to a net.

An Altium internal plane is a NEGATIVE layer: the copper is everywhere except where the plane is cleared, and the net lives on the LAYER, not on a poured object. Pouring a polygon on a plane layer is a different thing and does not connect the plane, so this is the tool for "make Internal Plane 1 the PGND plane" -- pcb_place_polygon_rect is not.

The net must already exist on the board (see pcb_get_nets). The layer must be an internal plane; a signal layer is refused with NOT_A_PLANE. Layer names are resolved against the real stack, so both "Internal Plane 1" (as pcb_get_layer_stackup prints it) and "InternalPlane1" work, and a name this board does not have is refused with UNKNOWN_LAYER rather than silently retargeting another layer.

The net is written to the board's InternalPlaneNetName for that layer and READ BACK before reporting; if that does not take, the layer object's own net is tried and read back too. When neither reads back the net the call answers success: false with applied: false and a note, and the board is NOT marked changed.

Args: layer: Internal plane layer, e.g. "InternalPlane1" or the name the stackup reports for it net: Existing net name to tie the plane to, e.g. "PGND"

Returns: Dictionary with "success", "layer" (the RESOLVED layer), "layer_name", "net", "net_readback", "applied", "route" (which write took) and "note".

Input Schema

NameRequiredDescriptionDefault
netYes
layerYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.9/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden and does so thoroughly: it discloses the write route, the read-back verification, the fallback path, and the failure contract ('success: false', 'applied: false', board NOT marked changed). Error codes NOT_A_PLANE and UNKNOWN_LAYER and the no-silent-retarget guarantee are exactly the behavioral context an agent needs for a mutation.

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?

The core action is front-loaded in the first sentence, and the structure moves logically from semantics to prerequisites to write/failure behavior. It is somewhat verbose with the negative-layer exposition and parenthetical asides, though each element is genuinely useful.

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?

For a 2-param mutation with no annotations, everything an agent needs is present: prerequisites, error cases, name-resolution rules, write/failure semantics, and return keys. An output schema already exists, so the explicit Returns section is slightly redundant but not harmful.

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 coverage is 0% (both params are bare), so the description must compensate and does: it explains layer name resolution ('Internal Plane 1' as printed by pcb_get_layer_stackup and 'InternalPlane1' both work, unknown names refused), and constrains net to an existing board net. This adds meaning well beyond the empty schema titles.

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 ('tie an internal plane layer to a net') and immediately qualifies what a plane layer is. Crucially, it names the sibling it is NOT (pcb_place_polygon_rect) and explains why, so an agent can disambiguate without opening the 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 explicit when-to-use ('make Internal Plane 1 the PGND plane'), when-not (pouring a polygon on a plane layer), and prerequisites (the net must already exist, see pcb_get_nets; the layer must be an internal plane or NOT_A_PLANE). Alternatives and conditions are fully spelled out.

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