Skip to main content
Glama

add_layout_legend

Add a legend to an ArcGIS Pro layout, tied to a map frame. Specify position, size, title, and layers to control what the legend shows.

Instructions

Add a legend tied to a layout's map frame.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
xNoX position in page units.
yNoY position in page units.
nameNoElement name.
titleNoLegend title.
widthNoWidth in page units.
heightNoHeight in page units.
layersNoOnly show these layers in the legend.
style_itemNoLegend style item name.
layout_nameYesLayout name.
map_frame_nameNoMap frame to describe.Map Frame

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.1

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, yet it says nothing about side effects on the layout, whether the change is persisted only via save_project, permission needs, or defaults applied when optional params are omitted. 'Add' implies mutation but no mutation semantics are disclosed.

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?

A single, well-formed sentence with no filler, front-loading the action and target. It is appropriately sized, though it is arguably under-specified rather than merely concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 explained, and the schema fully documents parameters. However, for a 10-parameter mutation tool with no annotations, the description omits prerequisite and persistence context that an agent would want before calling it.

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 each of the 10 parameters is documented in the schema (x/y in page units, layers to include, style_item, etc.). The description adds no parameter meaning beyond that, so the baseline 3 applies.

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 (add) and resource (legend) and scopes it to a layout's map frame, which distinguishes it from sibling add_layout_* tools like add_layout_text or add_layout_scale_bar. It does not explicitly name those siblings, but the resource is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this versus other layout-element tools, and no prerequisites stated (e.g., the layout and named map frame must already exist). The agent must infer everything about context.

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