Skip to main content
Glama

photoshop_set_active_artboard

Idempotent

Select an artboard by ID or exact name to make it active, so subsequent edits and Select All target that board instead of another frame.

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoExact artboard name (ambiguous if duplicates — use artboard_id)
artboard_idNoLayer id from photoshop_list_artboards / photoshop_get_state
document_idYesPhotoshop document id from photoshop_get_state / photoshop_list_documents. Send null or 0 to use the active document. A positive number activates that document before the tool runs. When no document is open, a stale id does not block the call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.7.33
    • changedInput schema / properties / document_id / description
      Previous value: -"Photoshop document id from photoshop_get_state / photoshop_list_documents. Send null to use the active document. A number activates that document before the tool runs."New value: +"Photoshop document id from photoshop_get_state / photoshop_list_documents. Send null or 0 to use the active document. A positive number activates that document before the tool runs. When no document is open, a stale id does not block the call."
  2. Changed4 schema fields changedv1.7.32
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / document_id / description
      Previous value: -"Optional 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."New value: +"Photoshop document id from photoshop_get_state / photoshop_list_documents. Send null to use the active document. A number activates that document before the tool runs."
    • changedInput schema / properties / document_id / type
      Previous value: -"number"New value: +[
      +  "number",
      +  "null"
      +]
    • addedInput schema / required
      Added value: +[
      +  "document_id"
      +]
  3. Addedv1.7.20

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly=false, idempotent=true, destructive=false. The description adds value beyond them by naming the precondition (target artboard must exist, discoverable via photoshop_list_artboards) and the side effect (changes the active layer), which the annotations do not cover. It stops short of describing failure behavior or ambiguity resolution details.

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?

Front-loaded with the action and primary identifier, then cleanly partitioned into Use when / Do NOT use when / Returns / Preconditions / Side effects. Every sentence carries operational information with no filler.

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?

Given no output schema, the description supplies the return shape (JSON with ok, summary, details.artboard), the precondition, and the side effect. An agent has everything needed to call it correctly and understand the consequence.

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%, so the baseline would be 3, but the description adds a meaningful selection preference (artboard_id over name) that the schema only hints at via the 'ambiguous if duplicates' note. It does not explain the null/0 document_id convention, which the schema already handles.

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 (select) and resource (artboard layer group) with the exact discriminators (artboard_id preferred, unique name fallback) and the downstream effect ('so subsequent edits and Select All target that board'). It is clearly distinguishable from the sibling photoshop_set_active_document, which it explicitly names.

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?

Provides explicit 'Use when' and 'Do NOT use when' clauses and routes the agent to the correct alternative (photoshop_set_active_document) for the confusable case of switching document tabs. Nothing is left to inference.

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