Skip to main content
Glama
alisaitteke

Photoshop MCP Server

by alisaitteke
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

photoshop_list_artboards

Read-onlyIdempotent

Lists artboards (ID, name, pixel bounds, active layer) in the active Photoshop document. Use for UI/multi-screen designs needing artboard IDs before export or edits.

Instructions

List artboards in the active document with id, name, pixel bounds, and which one contains the active layer.

Users often say: artboards, 画板, multi-screen, iPhone and iPad frames, device layouts.

Use when: the document is an artboard file (UI/multi-screen) and you need artboard_id before export or edits. Do NOT use when: listing open document tabs — use photoshop_list_documents.

Returns: JSON { ok, summary, details: { count, artboards[] } }. Empty list if the document has no artboards. Preconditions: active document. Side effects: none.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, so the safety profile is covered. The description adds genuinely new context beyond that: preconditions (active document), side effects (none), empty-list behavior, and the return shape. It stops short of richer behavioral detail but is solid given annotation coverage.

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-loaded with the core purpose, then structured labels for triggers, alternatives, returns, preconditions, and side effects. The "Users often say" synonym line (including 画板) earns its place for retrieval matching, though the description is on the longer side.

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?

No output schema exists, but the description supplies the return JSON shape and the empty-list edge case, plus preconditions and side effects. An agent has everything needed to call it correctly for a single-parameter list tool.

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 the single document_id parameter is fully documented in the schema (including null/0 semantics). The description adds only the phrase "active document," which mirrors the schema rather than extending it, so the baseline of 3 is appropriate.

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 ("List") and resource ("artboards in the active document") and enumerates the returned fields (id, name, pixel bounds, active-layer containment). An agent can immediately distinguish it from sibling listing tools like photoshop_list_documents.

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?

Explicit routing: "Use when: the document is an artboard file... you need artboard_id before export or edits" and "Do NOT use when: listing open document tabs — use photoshop_list_documents." Both the trigger condition and the named alternative are present, which is the top of the scale.

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