Skip to main content
Glama

photoshop_set_active_artboard

Select an artboard layer group by ID or exact name so subsequent edits and Select All target the correct board when switching between device frames.

Instructions

Select an artboard layer group by artboard_id (preferred) or unique name so subsequent edits and Select All target that board.

Use when: switching between device frames in an artboard document. Do NOT use when: switching document tabs — use photoshop_set_active_document.

Returns: JSON { ok, summary, details: { artboard } }. Preconditions: target artboard exists (photoshop_list_artboards). Side effects: changes the active layer.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "photoshop_set_active_artboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoExact artboard name (ambiguous if duplicates — use artboard_id)
artboard_idNoLayer id from photoshop_list_artboards / photoshop_get_state
document_idNoOptional Photoshop document id from photoshop_get_state / photoshop_list_documents. When set, the tool activates that document before running so a UI tab switch cannot retarget the edit.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.2

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral burden and does well: it discloses the side effect ('changes the active layer'), states the return shape as JSON, and notes the precondition that the target artboard must exist. It could go further by explicitly confirming that no artboard content is modified, but the stated side effect largely covers this.

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 front-loads the core action and then uses compact labeled lines for usage, return, preconditions, and side effects. Every sentence adds useful information with no filler.

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 covers usage, exclusions, return format, preconditions, and side effects, which is strong for a tool without an output schema. The main gap is that although all parameters are technically optional in the schema, the description does not explicitly state that at least one of artboard_id or name must be supplied.

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

Parameters4/5

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

Schema coverage is 100% and each parameter is already well described in the input schema. The description adds value by marking artboard_id as the preferred identifier and connects selection to downstream behavior, but much of the parameter meaning still relies on the schema.

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 states a specific verb and resource: 'Select an artboard layer group' by artboard_id or name, and clarifies the purpose ('so subsequent edits and Select All target that board'). It also differentiates from the sibling photoshop_set_active_document, so an agent can distinguish the tool correctly.

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?

It gives explicit when-to-use language: 'Use when: switching between device frames in an artboard document.' It explicitly says when not to use it and names the alternative: 'Do NOT use when: switching document tabs — use photoshop_set_active_document.' It also names the precondition to check photoshop_list_artboards.

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