Name: Adobe Photoshop MCP
Author: zachshallbetter

Adobe Photoshop MCP

Drive Adobe Photoshop from any MCP client: layers, selections, adjustments, type and export.

Grade A Local · stdio No auth needed 206 tools v0.1.0

No reviews yet by zachshallbetternpm Runs on your machine, nothing hosted

99/100

trust score

206

tools declared

local

runs on your machine

—

downloads a day

What it does

Drive Adobe Photoshop from any MCP client: layers, selections, adjustments, type and export.

Quickstart

# 1 — add it to Claude Code
claude mcp add --scope user zachshallbetter-photoshop-mcp '--' npx -y adobe-mcp-photoshop

# 2 — ask your agent for something these tools do
#   fill_contents, draw_gradient, stroke_path and 203 more

Adobe Photoshop MCP costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.

Publisher

zachshallbetter6 servers

1 category · publishing since 2026

All 6 servers

Installation

Where are you running it?

Every route below installs the same thing and ends at the same approval screen. This one runs on your machine: your client starts Adobe Photoshop MCP as a process under your own user, with your files and your network, so the tool surface below is what it can do to your computer rather than to a server somewhere else. Its scan result is on the Security tab — read the surface before you approve it.

Claude Codedeclared by this listing

This is a public server: you run it yourself and this marketplace is not in the path. You need Node.js — the current LTS (24) is the safe choice; npx comes with it. Claude Code registers it in one command; --scope user makes it available in every project. The '--' is in quotes so that PowerShell passes it on.

claude mcp add --scope user zachshallbetter-photoshop-mcp '--' npx -y adobe-mcp-photoshop

Reconnect, or start a new session, and the tools appear in the model’s tool list.

Free on mcprush, and it runs from its publisher’s own package: this marketplace is not in the path, so there is no key of ours to hold and no card to add.

What it asks of you

Nothing is required, but it can take PHOTOSHOP_APP_NAME (macOS only: address a specific copy, e.g. "Adobe Photoshop 2025". Default: Photoshop by bundle id), PHOTOSHOP_ALLOWED_DIRS (Extra directories allowed for file operations (':' on macOS, ';' on Windows)), PHOTOSHOP_SCRIPT_TIMEOUT_MS (How long to wait for Photoshop before reporting that a dialog may be open. Default 120000) if you want to set them.

What it writes

One config entry your client uses to start the process locally. A local server runs with your file system and your network, which is why it is priced without metering.

What you approve

206 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.

Tool surface

What the model actually sees. Descriptions are diffed on every release — see version history.

Only tools that write or reach the network

Fill the selection (or the whole layer when nothing is selected) on the active layer with the foreground or background colour, black, 50% gray, white, a pattern, a History state, or Content-Aware fill (Edit > Fill). A pattern fill can run one of the scripted patterns Photoshop ships (Edit > Fill >…

Parameter	Type	Required	Notes
contents	string	yes	What to fill with; gray is 50% gray
pattern	string	no	Pattern name (from the Patterns panel), for contents pattern
script	string	no	Contents pattern: lay the pattern out with this scripted pattern (the Script option)
scriptOptions	object	no	—
scriptPath	string	no	With script place_along_path (required) or random_fill: the path in the Paths panel to place the pattern along
historyIndex	integer	no	History state to fill from (list_history), for contents history. Default 0, the opening state
colorAdaptation	boolean	no	Content-Aware: blend the fill's colour with its surroundings. Default true
rotationAdaptation	boolean	no	Content-Aware: allow rotated samples. Default false
scale	boolean	no	Content-Aware: allow scaled samples. Default false
mirror	boolean	no	Content-Aware: allow mirrored samples. Default false
blendMode		no	—
opacity		no	—
preserveTransparency	boolean	no	Leave transparent pixels transparent. Default false

Draw a classic gradient on the active layer, inside the selection if there is one, from one point to another (Gradient tool in Classic gradient mode): linear, radial, angle, reflected or diamond, with colour and opacity stops, reverse, dither, transparency and interpolation. Without colours it…

Parameter	Type	Required	Notes
from		yes	Start point, pixels from the top-left
to		yes	End point, pixels from the top-left
type	string	no	Default linear
colors	array	no	Colour stops. Default foreground to background
opacities	array	no	Opacity stops. Default fully opaque throughout
reverse	boolean	no	Reverse the colour order. Default false
dither	boolean	no	Dither to reduce banding. Default true
transparency	boolean	no	Use the opacity stops (the Transparency option). Default true
interpolation	string	no	How colours blend between stops. Default perceptual
blendMode		no	—
opacity		no	—

Paint along a path on the active layer with a painting or retouching tool, using that tool's current brush and options (Paths panel > Stroke Path). Give a path from the Paths panel or points for a temporary one. Set the brush first with set_tool_options. Clone Stamp and Healing Brush need…

Parameter	Type	Required	Notes
tool	string	yes	The tool to paint with
closed	boolean	no	With points: close the temporary path. Default false
simulatePressure	boolean	no	Taper the stroke as if drawn with a pressure-sensitive pen. Default false
cloneSource	object	no	Clone Stamp and Healing Brush: where to sample from, as Alt-clicking does

Fill the area inside a path on the active layer with a colour (Paths panel > Fill Path), with blend mode, opacity, feather and anti-aliasing. Give a path from the Paths panel or points for a temporary one

Parameter	Type	Required	Notes
color		no	—
blendMode	string	no	Default normal
opacity		no	—
preserveTransparency	boolean	no	Default false
feather	number	no	Pixels. Default 0
antiAlias	boolean	no	Default true

Fill (Paint Bucket tool) or erase (Magic Eraser tool) the area of similar colour around a point on the active layer, within the selection if there is one. Erasing on the Background layer turns it into an ordinary layer, as the Magic Eraser does

Parameter	Type	Required	Notes
action	string	yes	—
x	number	yes	Pixels from the left
y	number	yes	Pixels from the top
tolerance	integer	no	How different a colour may be and still be included. Default 32
contiguous	boolean	no	Only connected pixels. Default true
antiAlias	boolean	no	Smooth the edge. Default true
sampleAllLayers	boolean	no	Judge colours from all visible layers. Default false
color		no	—
blendMode	string	no	Fill only. Default normal
opacity		no	—

Choose the active tool and set its options bar: a brush preset (Brushes panel or the Brush Preset picker), size, hardness, opacity, flow, blend mode, the tablet pressure buttons for size and opacity, Smoothing and its options (Pulled String Mode, Stroke Catch-up, Catch-up on Stroke End, Adjust for…

Parameter	Type	Required	Notes
tool	string	no	Tool to make active. Default the current tool
preset	string	no	Brush preset name, as the Brushes panel lists it
size	number	no	Brush diameter in pixels
hardness	number	no	Brush hardness, percent
opacity	integer	no	Tool opacity, percent
flow	integer	no	Tool flow, percent
paintingCursors	string	no	How painting cursors look

Brush presets and files (Brushes panel and its menu): load a brush file (.abr) as the current tool's brush (Import Brushes), save the current tool's brush to a file (Export Selected Brushes), define a preset from the selection, or the whole image when nothing is selected (Edit > Define Brush…

Parameter	Type	Required	Notes
action	string	yes	—
filePath	string	no	Import or export: absolute path to a .abr file
name	string	no	Define and new_preset: the new preset's name. Rename: the new name
preset	string	no	Rename and delete: the preset's name, as the Brushes panel lists it
append	boolean	no	Reset: add the default brushes to the current ones instead of replacing them. Default false

Repair or move the selected area on the active pixel layer by an offset: patch it from nearby pixels (Patch tool, Normal or Content-Aware), or move or extend it and fill the gap (Content-Aware Move tool). Needs a selection; dx and dy are the drag in pixels

Parameter	Type	Required	Notes
method	string	yes	—
dx	number	yes	Horizontal offset in pixels, positive to the right
dy	number	yes	Vertical offset in pixels, positive downward
patchMode	string	no	Patch: how the patch blends. Default content_aware
patchFrom	string	no	Patch: source repairs the selection with the pixels at the offset; destination copies the selection to the offset. Default source
transparent	boolean	no	Patch: blend the sampled texture transparently. Default false
moveMode	string	no	Content-Aware Move: move the content, or extend (duplicate) it. Default move
structure		no	—
color		no	—
sampleAllLayers	boolean	no	Sample all visible layers. Default false

Set the current tool's brush in the Brush Settings panel (Window > Brush Settings): Brush Tip Shape (size, hardness, angle, roundness, spacing, flip), Shape Dynamics, Scattering, Texture, Dual Brush, Color Dynamics, Transfer and Brush Pose, each section's on/off switch, the jitters and their…

Parameter	Type	Required	Notes
tool	string	no	Tool to make active first. Default the current tool
clearControls	boolean	no	Clear Brush Controls (Brush Settings panel menu) before applying the rest

Use the Clone Source panel (Window > Clone Source) and its menu: choose which of the five clone sources the Clone Stamp and Healing Brush use, reset the active source's scale and rotation (Reset Transform), and toggle the overlay options Show Overlay, Auto Hide, Clip to Brush Tip and Invert. The…

Parameter	Type	Required	Notes
source	integer	no	Clone source to make active, 1-5
resetTransform	boolean	no	Reset the active source's offset scale and rotation (Reset Transform)
toggle	array	no	Overlay options to toggle, in order

List the Actions panel's action sets and the actions in each, optionally with each action's recorded steps (Window > Actions)

Parameter	Type	Required	Notes
steps	boolean	no	Include each action's step names. Default false

Change the Actions panel: create an empty set, delete a set, an action or one of its steps, clear every set, reset to Default Actions, load an .atn file or one of Photoshop's bundled sets, or save a set as an .atn file (Actions panel menu)

Parameter	Type	Required	Notes
operation	string	yes	create_set (New Set), delete (Delete), clear_all (Clear All Actions), reset (Reset Actions: clear, then load Default Actions), load (Load Actions), save (Save Actions)
set	string	no	Set name: the new set for create_set, the set to delete, save, or that holds action
action	string	no	delete: the action to delete (or whose step to delete) inside set
step	integer	no	delete: the step number (1 = first) inside action
filePath	string	no	load or save: absolute path of an .atn file
preset	string	no	load: a set bundled in Photoshop's Presets/Actions folder, e.g. "Frames", "Image Effects", "Production"

Set how actions play back (Actions panel menu > Playback Options: accelerated, step by step, or pause between steps), and toggle Button Mode or Allow Tool Recording

Parameter	Type	Required	Notes
playback	string	no	Playback Options performance
pauseSeconds	integer	no	Seconds between steps, for playback pause. Default 1
toggleButtonMode	boolean	no	Switch Button Mode on or off (it toggles; the panel shows the current state)
toggleToolRecording	boolean	no	Switch Allow Tool Recording on or off (it toggles)

Play an action on every file in a folder, a list of files, or the open documents, and leave, save over, or save them to a folder (File > Automate > Batch). Long batches can outlast the script timeout (PHOTOSHOP_SCRIPT_TIMEOUT_MS)

Parameter	Type	Required	Notes
sourceFolder	string	no	Source: every file in this absolute folder path
includeSubfolders	boolean	no	Include All Subfolders of sourceFolder. Default false
extensions	array	no	Only files with these extensions from sourceFolder, e.g. ["jpg", "png"]
files	array	no	Source: these absolute file paths
openDocuments	boolean	no	Source: the open documents (Opened Files); each must have been saved

Save an action as a droplet: an application that plays the action on files dropped onto it, with Batch's open, save and naming options (File > Automate > Create Droplet)

Parameter	Type	Required	Notes
filePath	string	yes	Absolute path of the droplet to create (an .app on macOS, an .exe on Windows)

Run a File > Automate or File > Scripts command on the active document without its dialog: crop_and_straighten (Crop and Straighten Photos: each scanned photo into its own document), fit_image (Fit Image: resize to fit a box), conditional_mode_change (Conditional Mode Change), lens_correction…

Parameter	Type	Required	Notes
command	string	yes	—
width	number	no	fit_image: box width in pixels
height	number	no	fit_image: box height in pixels
dontEnlarge	boolean	no	fit_image: leave images already smaller than the box. Default false
sourceModes	array	no	conditional_mode_change: convert only from these modes. Default all
targetMode	string	no	conditional_mode_change: the mode to convert to
flatten	boolean	no	conditional_mode_change: flatten while converting. Default false
distortion	boolean	no	lens_correction: correct geometric distortion. Default true
chromaticAberration	boolean	no	lens_correction: correct chromatic aberration. Default false
vignette	boolean	no	lens_correction: remove vignetting. Default false
autoScale	boolean	no	lens_correction: scale to hide blank edges. Default true
edge	string	no	lens_correction: fill for edges left blank. Default transparency

Combine image files into a new document with one of Photoshop's multi-file commands, without its dialog: stack (File > Scripts > Load Files into Stack), photomerge (File > Automate > Photomerge panorama), hdr (File > Automate > Merge to HDR Pro, with its last-used settings) or statistics (File >…

Parameter	Type	Required	Notes
method	string	yes	—
files	array	yes	Absolute paths of two or more images
align	boolean	no	stack, hdr, statistics: auto-align the layers. Default false (hdr: true)
smartObject	boolean	no	stack: convert the stack into a smart object. Default false
layout	string	no	photomerge: Auto (default), Perspective, Cylindrical, Spherical, Collage or Reposition
blend	boolean	no	photomerge: Blend Images Together. Default true
vignetteRemoval	boolean	no	photomerge: Vignette Removal. Default false
distortionCorrection	boolean	no	photomerge: Geometric Distortion Correction. Default false
fillTransparent	boolean	no	photomerge: Content Aware Fill Transparent Areas. Default false
statistic	string	no	statistics: the stack mode. Default median

List, add or remove the scripts and actions Photoshop runs when an event happens, and turn them on or off (File > Scripts > Script Events Manager)

Parameter	Type	Required	Notes
operation	string	yes	—
event	string	no	add: the event, as a four-character code or event id, e.g. "Opn " (Open Document), "save", "Mk " (New Document)
eventClass	string	no	add: the class the event applies to, e.g. "Dcmn" to fire Make only for documents
scriptFile	string	no	add: absolute path of the .jsx or .js script to run
index	integer	no	remove: the notifier's index from list

Work with variable data sets on the active document: import them from a text file (File > Import > Variable Data Sets), apply one (Image > Apply Data Set), or save a PSD per data set into a folder (File > Export > Data Sets as Files). Variables themselves are defined in Image > Variables > Define

No parameter schema on file.

Open a camera raw file through Camera Raw without its dialog, with the camera's defaults, the settings last used, or custom Basic, Detail, Lens and Calibration values and Workflow Options (colour space, bit depth, size, resolution). These are the object model's older Camera Raw controls

Parameter	Type	Required	Notes
filePath	string	yes	Absolute path to the raw file
settings	string	no	camera (Camera Raw defaults), selected_image (the settings last used) or custom (the values given). Default custom when values are given, otherwise camera
whiteBalance	string	no	White balance preset
calibration	object	no	Calibration: hue and saturation of each primary and the shadow tint, each -100 to 100
colorSpace	string	no	Workflow Options: colour space
bitsPerChannel	integer	no	Workflow Options: bit depth
size	string	no	Workflow Options: image size

Apply Filter > Camera Raw Filter to layers without its dialog, with the settings of its panels: Basic (white balance, exposure, contrast, highlights, shadows, whites, blacks, texture, clarity, dehaze, vibrance, saturation), Curve (parametric regions and splits, point curves, refine saturation),…

Parameter	Type	Required	Notes
target		no	Pixel or smart object layers. Default the active layer
settings	object	no	Camera Raw slider values. Temperature and tint are relative (-100 to 100) and set white balance to Custom
whiteBalance	string	no	Basic: White Balance. as_shot uses the camera's; custom goes with temperature and tint (the default when they are given)
hsl		no	—
colorGrading	object	no	Color Grading: shadows, midtones, highlights and global wheels { hue 0-360, saturation 0-100, luminance -100 to 100 }, blending 0-100 and balance -100 to 100
pointCurve		no	—
localCorrections	array	no	Masking: local corrections, each a mask and the sliders it applies. mask: { type: "linear", from: { x, y } (no effect), to: { x, y } (full effect) }, { type: "radial", bounds: { x, y, width, height },

Run a Neural Filter (Filter > Neural Filters) on the active layer without its workspace: Depth Blur, Style Transfer or Photo Restoration. The filter must already be downloaded in the Neural Filters panel; some filters process in the cloud and need a signed-in Adobe account

Parameter	Type	Required	Notes
filter	string	yes	The filter
style	string	no	style_transfer: preset style id. Default "style28_crop"
preserveColor	boolean	no	style_transfer: keep the image's colours. Default false
options	object	no	Sliders, 0-100. depth_blur: aperture, focalDistance, focalRange, haze. style_transfer: brushSize, preserveWeight, blur. photo_restoration: enhance (Photo Enhancement), faceEnhance (Enhance Face), scra

Replace the sky in the active document (Edit > Sky Replacement) with an image file, without the dialog. Photoshop finds the sky, adds a Sky Replacement group with the new sky and lighting and colour layers, and returns it. Edge, brightness, temperature, lighting and colour settings match the…

Parameter	Type	Required	Notes
skyFile	string	yes	Absolute path to the sky image (a Sky_Presets image or any JPEG or PNG)
lightingMode	string	no	Lighting mode for the foreground lighting layer. Default screen; Photoshop may choose its own blend from the sky
output	string	no	Output to new layers (default) or a duplicate layer

Remove the background of layers (the Properties panel's Remove Background quick action): Photoshop finds the subject and adds a layer mask hiding the rest. It uses the Select Subject model, which may process in the cloud depending on Preferences > Image Processing

Parameter	Type	Required	Notes
target		no	Layers. Default the active layer

Apply the last filter again, with the same settings, to layers (Filter > Last Filter). A filter must have been applied in this Photoshop session

Parameter	Type	Required	Notes
target		no	Layers. Default the active layer

Fade the filter, adjustment or paint stroke just applied: blend it with what was there before at an opacity and blend mode (Edit > Fade). Only works directly after that edit

Parameter	Type	Required	Notes
opacity	number	yes	Percent of the edit to keep
mode	string	no	Blend mode. Default normal

Apply an Image > Adjustments command to pixel layers (inside the selection, if there is one). This changes the pixels; it does not add an adjustment layer. auto_color_correction applies Auto with an algorithm from Auto Color Correction Options, once; match_color adjusts the layer on its own (Match…

No parameter schema on file.

Describe the running Photoshop (About Photoshop, System Info): version, build, locale, free memory, the preferences folder, the file types it opens, the script dialog mode, and optionally the full System Info report or whether named features are enabled

Parameter	Type	Required	Notes
systemInfo	boolean	no	Include the Help > System Info report (long). Default false
features	array	no	Feature names to check with Application.featureEnabled, e.g. "photoshop/extended"

Read Photoshop's preferences (Photoshop > Settings, or Edit > Preferences on Windows) that scripts can reach: general, interface, file handling, performance, cursors, transparency, units and rulers, guides and grid, plug-ins, type, and the script dialog mode

No parameter schema on file.

Change Photoshop's preferences (Photoshop > Settings, or Edit > Preferences on Windows). Give only the settings to change; the result lists every preference afterwards. Some take effect after a restart

No parameter schema on file.

Free memory with Edit > Purge: the undo buffer, the clipboard, the histories of open documents, or all of them. It cannot be undone

Parameter	Type	Required	Notes
target	string	no	What to purge. Default all

Run an application command: beep, bring Photoshop to the front, redraw the screen, hide Photoshop or the other applications or show them all again (Photoshop menu, macOS only), open Help > Photoshop Help, or open the Creative Cloud account page in the browser

Parameter	Type	Required	Notes
command	string	yes	The command

Run any Photoshop menu command by its string id (e.g. "toggleRulers") or four-character id (e.g. "TglR"), as Application.runMenuItem does. A command that opens a dialog shows it and waits; prefer the specific tools

Parameter	Type	Required	Notes
stringID	string	no	Menu command string id, e.g. "screenModeFullScreen"
charID	string	no	Four-character menu command id, e.g. "ZmIn"

Store, read or erase named values that persist in Photoshop between sessions (Application.putCustomOptions, getCustomOptions and eraseCustomOptions), for keeping settings across calls

Parameter	Type	Required	Notes
action	string	yes	get the values, set (replace) them, or erase them
key	string	yes	A unique key, e.g. "com.example.myScript"
values	object	no	set: { name: string, number or boolean }. Names are letters, digits and underscores
persistent	boolean	no	set: keep after Photoshop quits. Default true

Quit Photoshop (File > Exit, or Photoshop > Quit Photoshop on macOS). Refuses while documents have unsaved changes unless discardUnsaved is true, which closes them without saving first

Parameter	Type	Required	Notes
discardUnsaved	boolean	no	Close documents with unsaved changes without saving them. Default false

List the active document's artboards with id, name, position and size in pixels, layer count and background (Artboard properties in the Properties panel)

No parameter schema on file.

Create an artboard: new at a position and size (Layer > New > Artboard), from layers (Artboard from Layers), from a group (Artboard from Group), or a new document of type Artboard (File > New). The steps in the document form one history state

Parameter	Type	Required	Notes
from	string	no	Default new
target		no	layers: the layers to put on the artboard. group: the group to convert
name	string	no	Artboard (or document) name
x	number	no	new: left edge in pixels. Default to the right of the existing artboards
y	number	no	new: top edge in pixels. Default 0
width	number	no	new, document: width in pixels
height	number	no	new, document: height in pixels
resolution	number	no	document: pixels per inch. Default 72
background		no	—

Change artboards: set name, position, size, background colour and auto-nesting (Properties panel), duplicate one, ungroup them back to layers (Layer > Ungroup Artboards), clear their guides (View > Guides > Clear Selected Artboard Guides), add guides from a shape (New Artboard Guides From Shape),…

Parameter	Type	Required	Notes
operation	string	yes	—
target		no	The artboards (ids from get_artboards); for guides_from_shape, the shape layer
name	string	no	set, duplicate: new name
x	number	no	set, duplicate: left edge in pixels
y	number	no	set, duplicate: top edge in pixels
width	number	no	set: width in pixels
height	number	no	set: height in pixels
background		no	—
autoNest	boolean	no	set: let layers moved onto or off the artboard nest into or out of it automatically (false prevents auto-nesting)
tool	string	no	select_tool: the Artboard tool or the Frame tool

Put layers inside a frame (Add Frame to Layers) or turn a group into a frame (Add Frame To Layer Group); the frame clips its contents to its shape

Parameter	Type	Required	Notes
from	string	no	Default layers
target		yes	layers: the layers to frame. group: the group to convert

Save each artboard as its own file, cropped to the artboard with its background, as PNG, JPEG, PSD, TIFF or PDF (File > Export > Artboards to Files), or all of them as one multi-page PDF (Artboards to PDF). The document is not changed

Parameter	Type	Required	Notes
folder	string	yes	Absolute folder path
format	string	no	Default png
singlePdf	boolean	no	pdf: one multi-page PDF instead of one PDF per artboard. Default false
pdfName	string	no	singlePdf: the PDF file name. Default the document name
prefix	string	no	Text before each artboard name in the file names
target		no	Only these artboards. Default all
includeBackground	boolean	no	Fill with the artboard background colour (unless it is transparent). Default true

List open documents with their size in pixels, resolution, colour mode, bit depth, file and whether they have unsaved changes

No parameter schema on file.

Describe the active document: size in pixels, resolution, mode, bit depth, colour profile, layer count, active layer, channels, guides, selection bounds and history

No parameter schema on file.

Create a document (File > New, Preset Details) with a size in pixels, resolution, colour mode, bit depth, background fill, pixel aspect ratio and optional colour profile, optionally as an artboard document

Parameter	Type	Required	Notes
width	number	yes	Pixels
height	number	yes	Pixels
resolution	number	no	Pixels per inch. Default 72
name	string	no	Document name
mode	string	no	Default rgb
fill	string	no	Background contents. Default white
bitsPerChannel	integer	no	Default 8
colorProfile	string	no	Profile name, e.g. "sRGB IEC61966-2.1"
pixelAspectRatio	number	no	Pixel width over height for video work, e.g. 0.9 for D1/DV NTSC. Default 1 (square)
artboard	boolean	no	Create the document with an artboard (the New Document Artboards option). Default false

Open a file (File > Open, Open As): PSD, PSB, TIFF, JPEG, PNG, GIF, BMP, PDF, EPS, DCS, camera raw and DNG, HEIF, WebP, AVIF, JPEG XL, JPEG 2000, OpenEXR, Radiance, Cineon, DICOM, IFF, PCX, PICT, Pixar, PBM, Scitex CT, Targa, WBMP, Photoshop 2.0, Photoshop Raw, video and audio (as video layers),…

Parameter	Type	Required	Notes
filePath	string	yes	Absolute path
asSmartObject	boolean	no	Open as a smart object. Default false
openAs	string	no	Read the file as this format, with options. pdf: a generic (not Photoshop) PDF page or image, rasterized (Import PDF). eps: rasterize generic EPS. raw: headerless Photoshop Raw data. dicom: medical im
options	object	no	—

Save the active document in place, or at filePath in the format its extension names, with that format's options (File > Save As): PSD, PSB (Large Document Format), TIFF, PNG, JPEG, Photoshop PDF, GIF, Photoshop EPS, DCS 1.0 and 2.0 (.eps with epsType), BMP, Targa (.tga), Pixar (.pxr) or Photoshop…

Parameter	Type	Required	Notes
filePath	string	no	Absolute path ending in …. Omit to save in place
asCopy	boolean	no	Save a copy. Default false
layers	boolean	no	PSD, TIFF, PDF: keep layers
embedColorProfile	boolean	no	Embed the colour profile (PSD, TIFF, JPEG, PDF, EPS, DCS). Default true
alphaChannels	boolean	no	PSD, TIFF: keep alpha channels
spotColors	boolean	no	PSD: keep spot channels
transparency	boolean	no	TIFF: keep transparency
compression		no	TIFF: none, lzw (default), zip or jpeg. PNG: 0-9 (default 6)
interlaced	boolean	no	PNG: interlaced
quality	integer	no	JPEG quality, 0-12. Default 10
format	string	no	JPEG: baseline, optimized (default) or progressive
preset	string	no	PDF: Adobe PDF preset name, e.g. "[High Quality Print]"
standard	string	no	PDF: PDF/X standard
preserveEditing	boolean	no	PDF: keep Photoshop editing capabilities
notes	boolean	no	PSD, TIFF, PDF: save the document's notes with it (the Notes save option)
epsType	string	no	.eps files: Photoshop EPS (default), Photoshop DCS 1.0 or DCS 2.0 (CMYK documents; DCS 2.0 keeps spot channels)
options	object	no	—

Duplicate the active document (Image > Duplicate), optionally merged into one layer

Parameter	Type	Required	Notes
name	string	no	—
mergeLayers	boolean	no	Duplicate merged layers only. Default false

Bring an open document to the front by name or index

Parameter	Type	Required	Notes
name	string	no	—
index	integer	no	—

Close the active document. Unsaved changes are discarded unless save is true

Parameter	Type	Required	Notes
save	boolean	no	Save before closing. Default false

Set the foreground and background colours used by fills, strokes, brushes and new documents

Parameter	Type	Required	Notes
foreground		no	—
background		no	—

Export the document as one PNG, PNG-8, JPEG or GIF file (Save for Web), optionally resized. Works on a temporary copy, so the document is unchanged

Parameter	Type	Required	Notes
outputFile	string	yes	Absolute path; the extension must match the format

Export each top-level layer or group (or the ones chosen) to its own file, named <prefix><layer name>.<ext>, by showing one at a time on a temporary copy (File > Export > Layers to Files)

Parameter	Type	Required	Notes
outputFolder	string	yes	Absolute folder path
ids	array	no	Top-level layer or group ids. Default all visible ones
prefix	string	no	File name prefix
trim	boolean	no	Trim each export to the layer's pixels. Default false

Quick Export the whole document, or chosen layers, groups or artboards, as PNG, JPG or GIF into a folder in one step (File > Export > Quick Export As; Layers panel > Quick Export As). Files are named after the document or each layer

Parameter	Type	Required	Notes
outputFolder	string	yes	Absolute folder path
fileType	string	no	Default png
quality	integer	no	JPG quality, 1-100. Default 90
includeMetadata	boolean	no	Include copyright and contact metadata. Default false
sRGB	boolean	no	Convert to sRGB. Default true
layers		no	Export these layers, groups or artboards, each to its own file. …. Default: the whole document

Export layer comps, each to its own file (File > Export > Layer Comps to Files) or as the pages of one PDF (Layer Comps to PDF). The document is returned to its state before the export

Parameter	Type	Required	Notes
to	string	no	Default files
outputFolder	string	no	files: absolute folder path
outputFile	string	no	pdf: absolute path ending in .pdf
comps	array	no	Layer comp names. Default all
fileType	string	no	files: psd, tiff, jpeg (default), png or pdf
quality	integer	no	JPEG quality, 0-12. Default 10
prefix	string	no	files: file name prefix; each file is <prefix><comp name>

Export paths as an Adobe Illustrator file (File > Export > Paths to Illustrator): all paths, one named path, or just the document bounds

Parameter	Type	Required	Notes
outputFile	string	yes	Absolute path ending in .ai
paths	string	no	Default all
pathName	string	no	named: the path's name in the Paths panel

Combine image files into one multi-page PDF or a full-screen PDF slideshow (File > Automate > PDF Presentation), in the order given (a file may repeat), optionally adding the open documents, with slideshow timing, looping and transitions, file names on the pages, and Photoshop PDF save options

Parameter	Type	Required	Notes
files	array	no	Absolute paths of the source files, in page order
includeOpenFiles	boolean	no	Add the open documents that have been saved (Add Open Files), after files. Default false
outputFile	string	yes	Absolute path ending in .pdf
pdfPreset	string	no	Adobe PDF preset name, e.g. "[Smallest File Size]"
pdfStandard	string	no	PDF/X standard
pdfOptions	object	no	Photoshop PDF options, as for save_document's PDF options

Set up Generator image assets (File > Generate > Image Assets): name layers with asset specs such as "icon.png", "200% hero@2x.png24" or "50x50 thumb.jpg80%" so Generator writes them to a folder next to the PSD, set the document-wide defaults layer ("default 200% @2x/"), and turn Image Assets on…

Parameter	Type	Required	Notes
assets	array	no	Layers to name as assets
defaults	string	no	Document-wide defaults written as an empty layer named "default <defaults>", e.g. "200% @2x/, 50% small/"
toggle	boolean	no	Switch Image Assets generation on or off for the document (it is a toggle). Default false

List the files in File > Open Recent, open one of them by its index, or clear the list (Clear Recent File List)

Parameter	Type	Required	Notes
action	string	no	Default list
index	integer	no	open: the file's index in the list

Close every open document (File > Close All). Unsaved changes are discarded unless save is true; with save, documents that have never been saved are refused before anything closes

Parameter	Type	Required	Notes
save	boolean	no	Save each document before closing it. Default false

Open Adobe Bridge (File > Browse in Bridge), or close the active document and switch to Bridge (File > Close and Go to Bridge). Needs Bridge installed

Parameter	Type	Required	Notes
closeDocument	boolean	no	Close the active document first. It must have no unsaved changes. Default false

Read the active document's File Info metadata: title, author, description, keywords, copyright, IPTC origin, categories, the camera data (Exif), and optionally the raw XMP packet

Parameter	Type	Required	Notes
includeXmp	boolean	no	Include the raw XMP packet. Default false

Set the active document's File Info metadata: title, author, description, keywords, copyright, IPTC origin and categories, or replace its whole XMP packet. Only the fields given change. Camera data (Exif) is read-only

Parameter	Type	Required	Notes
xmp	string	no	A complete XMP packet (<x:xmpmeta ...>) that replaces the document's metadata. Applied before the fields above

Work with notes (non-printing annotations): import the notes from a PDF or FDF file into the active document (File > Import > Notes), delete all of its notes (Note tool: Clear All), choose the Note tool, or show or hide the Notes panel (Window > Notes). Writing a note's text is done by hand with…

Parameter	Type	Required	Notes
action	string	yes	What to do
file	string	no	import: absolute path of a PDF or FDF file with notes

Set and read file-handling preferences: image previews saved with files (macOS icon and full-size previews, Mac and Windows thumbnails), the length of File > Open Recent, and the History Log (on or off, saved to the file's metadata or a text file, and its detail). Call with no settings to read them

Parameter	Type	Required	Notes
historyLogFile	string	no	Absolute path of the text file the History Log is written to

Place an image, PDF, vector or other file in the active document as a smart object (File > Place Embedded), or as a smart object linked to the file (File > Place Linked), positioned, scaled and rotated

Parameter	Type	Required	Notes
filePath	string	yes	Absolute path of the file to place
linked	boolean	no	Link to the file instead of embedding it. Default false
center	object	no	Where the placed item's centre goes, in pixels from the top-left. Default the document centre
scale	number	no	Scale in percent, both directions
scaleX	number	no	Horizontal scale in percent
scaleY	number	no	Vertical scale in percent
angle	number	no	Rotation in degrees

Resize the image (Image > Image Size): width and/or height in pixels (the other follows the aspect ratio when omitted), resolution, and the resampling method, with noise reduction for Preserve Details and optionally scaling layer styles (Scale Styles). With resample "none", only the resolution…

Parameter	Type	Required	Notes
width	number	no	Pixels
height	number	no	Pixels
scale	number	no	Percent of the current size, instead of width and height
resolution	number	no	Pixels per inch
resample	string	no	Default automatic
reduceNoise	number	no	Reduce Noise for resample "preserve_details", 0-100
scaleStyles	boolean	no	Scale layer styles with the image (Scale Styles). Given either way, the resize runs through the Image Size command; the aspect ratio is kept, so give width, height or scale, not both width and height

Change the canvas size (Image > Canvas Size) in pixels, keeping the image anchored at a side or corner. New areas take the Canvas Extension Color on a background layer (the background colour unless extensionColor is given) and stay transparent elsewhere

Parameter	Type	Required	Notes
width	number	no	Pixels (added to the current width when relative)
height	number	no	Pixels (added to the current height when relative)
relative	boolean	no	Width and height are added to the current size. Default false
anchor	string	no	Default center
extensionColor	string	no	Canvas Extension Color for new areas of a background layer. Default: the background colour

Crop the image to a rectangle (Image > Crop, or the Crop tool), optionally rotating the crop and resampling the result to a size. Bounds reaching outside the canvas extend it, as dragging the Crop tool past the edge does

Parameter	Type	Required	Notes
bounds		yes	—
angle	number	no	Rotate the crop, in degrees
width	number	no	Resample the result to this width in pixels
height	number	no	Resample the result to this height in pixels

Trim away transparent pixels, or pixels the colour of the top-left or bottom-right corner, from any of the four sides (Image > Trim)

Parameter	Type	Required	Notes
basedOn	string	no	Default transparent
top	boolean	no	—
left	boolean	no	—
bottom	boolean	no	—
right	boolean	no	—

Rotate the whole image by an angle in degrees (Image > Image Rotation); positive is clockwise. Or flip the canvas horizontally or vertically

Parameter	Type	Required	Notes
angle	number	no	—
flip	string	no	—

Convert the image to another colour mode (Image > Mode): RGB, CMYK, Grayscale, Lab, Bitmap, Indexed Color or Multichannel, and/or another bit depth. Indexed Color takes the palette, colours, forced colours, transparency, matte and dither of its dialog; Bitmap (from Grayscale) takes the method,…

Parameter	Type	Required	Notes
mode	string	no	—
bitsPerChannel	integer	no	—
indexed	object	no	Indexed Color options (mode "indexed")
bitmap	object	no	Bitmap options (mode "bitmap"; the image must be Grayscale)

Convert the image to another colour profile (Edit > Convert to Profile) with a rendering intent, black point compensation and dither

Parameter	Type	Required	Notes
profile	string	yes	Destination profile name, e.g. "sRGB IEC61966-2.1", "Working CMYK"
intent	string	no	Default relative_colorimetric
blackPointCompensation	boolean	no	—
dither	boolean	no	—

Flatten every layer into a background layer (Layer > Flatten Image), or merge only the visible layers (Merge Visible)

Parameter	Type	Required	Notes
visibleOnly	boolean	no	Merge visible layers only. Default false

Enlarge the canvas to show every pixel that extends beyond it (Image > Reveal All)

No parameter schema on file.

Replace the colour table of an Indexed Color image (Image > Mode > Color Table) with a list of colours, in table order

Parameter	Type	Required	Notes
colors	array	yes	Up to 256 colours; each is stored as RGB

Set the document's pixel aspect ratio (View > Pixel Aspect Ratio), for video work with non-square pixels, and/or toggle View > Pixel Aspect Ratio Correction, which previews the image with those pixels

Parameter	Type	Required	Notes
ratio	number	no	Pixel width divided by height: 1 is square, e.g. 0.91 for D1/DV NTSC, 1.09 for D1/DV PAL, 2 for anamorphic 2:1
toggleCorrection	boolean	no	Toggle Pixel Aspect Ratio Correction (on if it was off, off if it was on)

Read the histogram (Histogram panel) of the composite image or of one channel: the pixel count at each of the 256 levels, with the total, mean and median

Parameter	Type	Required	Notes
channel	string	no	Channel name, e.g. "Red" or an alpha channel (list_channels). Default the composite

Arrange document windows (Window > Arrange): tile, 2-up to 6-up, consolidate to tabs, cascade, float, open a new window for the active document, or match zoom, location or rotation across windows

Parameter	Type	Required	Notes
layout	string	yes	The Window > Arrange command

Zoom the active document (View > Zoom In, Zoom Out, Fit on Screen, 100%, 200%, Print Size) and choose the screen mode (View > Screen Mode: standard, full screen with menu bar, full screen)

Parameter	Type	Required	Notes
zoom	string	no	The View menu zoom command
screenMode	string	no	The screen mode

Toggle View menu items for the active document: Extras, each View > Show item (layer and selection edges, target path, grid, guides, count, smart guides, slices, notes, pixel grid, brush preview), Rulers, Lock Guides, Lock Slices, Snap and each Snap To item. show_all, show_none, snap_to_all and…

Parameter	Type	Required	Notes
items	array	yes	Items to toggle, in order

Show or hide panels (Window menu), hide or show all panels at once (Tab), reset to the Essentials workspace, and use the Histogram panel menu (compact, expanded or all-channels view, statistics, channels in colour, uncached refresh) and the Info panel's Color Samplers item

Parameter	Type	Required	Notes
show	array	no	Panels to show
hide	array	no	Panels to hide
toggleAllPanels	boolean	no	Hide all panels, or show them again (Application.togglePalettes)
workspace	string	no	Switch to Window > Workspace > Essentials (Default)
histogramView	string	no	Histogram panel view
toggleHistogram	array	no	Histogram panel options to toggle
refreshHistogram	boolean	no	Histogram panel Uncached Refresh
toggleInfoColorSamplers	boolean	no	Toggle the Info panel menu's Color Samplers item

Make a view tool current in the Tools panel: Hand, Zoom, Rotate View (needs the graphics processor), Slice or Slice Select. Using the tool on the canvas stays with the user

Parameter	Type	Required	Notes
tool	string	yes	The tool

Work with guides in the active document (View > Guides): add guides at pixel positions, lay out columns, rows and margins (New Guide Layout), make guides from the selected shape layer (New Guides From Shape), clear all guides or only canvas guides, or clear slices (View > Clear Slices). Returns…

Parameter	Type	Required	Notes
action	string	yes	What to do
direction	string	no	add: guide direction
positions	array	no	add: pixel positions from the top (horizontal) or left (vertical) edge
columns	integer	no	layout: number of columns
rows	integer	no	layout: number of rows
gutter	number	no	layout: space between columns and between rows, in pixels. Default 0
margin	object	no	layout: margins in pixels; a guide is placed at each margin given
clearExisting	boolean	no	layout: remove existing guides first. Default true
target		no	from_shape: the shape layer. Default the active layer

Add, change, hide or remove layer style effects (Layer > Layer Style), as the Layer Style dialog does. effects maps each effect to an options object (omitted options keep the current settings, or Photoshop's defaults for a new effect), true (add or keep with defaults), false (delete the effect),…

Parameter	Type	Required	Notes
target		no	—
effects	object	yes	For example { dropShadow: { distance: 8, size: 12 }, stroke: { size: 2, color: "#FFFFFF" }, outerGlow: false }
replace	boolean	no	Start from an empty style, dropping effects not given

Describe layers' styles: whether effects are shown, and each effect and instance with whether it is on and, with detail, all its settings

Parameter	Type	Required	Notes
target		no	—
detail	boolean	no	Include every setting of each effect

Copy one layer's style to other layers (Layer > Layer Style > Copy Layer Style, then Paste Layer Style, which replaces their styles), or copy only some effects, added to their own styles as Option/Alt-dragging an effect does

Parameter	Type	Required	Notes
source		yes	The one layer to copy from
target		yes	The layers to paste onto
effects	array	no	Copy only these effects (every instance), replacing the same effects on the targets. Default the whole style

Layer style commands (Layer > Layer Style): Clear Layer Style, Rasterize Layer Style (bake the effects into pixels), Scale Effects by a percentage, or hide or show all of a layer's effects

Parameter	Type	Required	Notes
target		no	—
action	string	yes	—
scale	number	no	scale: percent

Set a layer's Blending Options (Layer Style dialog): blend mode, opacity and fill opacity; Advanced Blending knockout, the channels it blends into and the group options (Blend Interior Effects as Group, Blend Clipped Layers as Group, Transparency Shapes Layer, Layer Mask Hides Effects, Vector Mask…

Parameter	Type	Required	Notes
target		yes	—
blendMode	string	no	Blend mode
opacity	number	no	Percent
fillOpacity	number	no	Fill opacity, percent (pixel, type and shape layers)
knockout	string	no	Knockout
channels	array	no	Channels the layer blends into, e.g. ["red", "blue"]; the document's own channel names
blendIf	array	no	Blend If, one entry per channel: { channel: "gray" or a colour channel, thisLayer: [black, black split, white split, white], underlyingLayer: [...] }, levels 0-255

Use the Styles panel: apply a loaded style preset to layers by name (replacing their styles), load a style library (.asl) into the panel, or save the panel's styles as a library (Styles panel menu: Load Styles, Save Styles)

Parameter	Type	Required	Notes
action	string	yes	—
target		no	apply: the layers. Default the active layer
style	string	no	apply: the style's name in the Styles panel
file	string	no	load, save: absolute path of the .asl file
append	boolean	no	load: add to the current styles (false replaces them)

List the layers and groups, top to bottom, with id, name, kind (pixel, text, smart object, adjustment, shape...), visibility, opacity, blend mode, lock, bounds in pixels and parent group. Ids are what other tools take in target.ids

Parameter	Type	Required	Notes
group	integer	no	Only inside this group (id)
depth	integer	no	How many group levels to descend. Default all

Add a new empty pixel layer or a group above the active layer, or inside a group

Parameter	Type	Required	Notes
type	string	no	Default layer
group	integer	no	Create inside this group (id)

Rename layers and set their opacity, fill opacity, blend mode, visibility and locks

Parameter	Type	Required	Notes
target		yes	—
locked	boolean	no	Lock all
lockPixels	boolean	no	Lock image pixels (pixel layers)
lockPosition	boolean	no	Lock position (pixel layers)
lockTransparency	boolean	no	Lock transparent pixels (pixel layers)

Make a layer the active one; many commands work on the active layer

Parameter	Type	Required	Notes
target		yes	—

Change the stacking order: bring to front, bring forward, send backward, send to back, or place above, below or inside another layer or group

Parameter	Type	Required	Notes
target		yes	—
order	string	yes	—
relativeTo	integer	no	Layer or group id, for above, below and inside

Put layers into a new group (Layer > Group Layers), placed where the first of them was; they keep the order given

Parameter	Type	Required	Notes
target		yes	—
name	string	no	—

Move a group's layers out to where the group was and remove the empty group (Layer > Ungroup Layers)

Parameter	Type	Required	Notes
target		yes	—

Duplicate layers or groups (Layer > Duplicate Layer), placed above each original, optionally renamed

Parameter	Type	Required	Notes
target		yes	—
name	string	no	Name for the copy (one layer only)

Delete layers or groups (with everything inside them)

Parameter	Type	Required	Notes
target		yes	—

Merge a layer into the one below (Merge Down), or merge a group into one layer (Merge Group)

Parameter	Type	Required	Notes
target		yes	—

Move layers by dx, dy pixels, scale them by a percentage, rotate them by degrees, or flip them, around an anchor point; optionally transform a copy of each, keeping the original. Video layers transform the same way once they are Smart Objects

Parameter	Type	Required	Notes
target		yes	—
dx	number	no	—
dy	number	no	—
scaleX	number	no	Percent; negative flips
scaleY	number	no	Percent; negative flips
angle	number	no	Degrees, clockwise
flip	string	no	—
anchor	string	no	Default center
duplicate	boolean	no	Transform a copy of each layer, placed above it. Default false

Rasterize type, shape, smart object or fill layers into pixels (Layer > Rasterize), or only one part of them

Parameter	Type	Required	Notes
target		yes	—
what	string	no	Default entire_layer

Link layers together so they move and transform as one, or unlink them

Parameter	Type	Required	Notes
target		yes	—
unlink	boolean	no	—

Turn the background layer into a normal layer that can move and hold transparency, or make a layer the background

Parameter	Type	Required	Notes
target		no	—
toBackground	boolean	no	Make the target the background layer. Default false: turn the background into a normal layer

Work with layer comps (Layer Comps panel): list, create, apply, update (recapture) or delete one; apply the previous or next comp; change a comp's options (Layer Comp Options); duplicate a comp; go back to the Last Document State; or clear a comp's warning (Clear Layer Comp Warning; every comp…

Parameter	Type	Required	Notes
action	string	yes	—
name	string	no	The comp to act on (create: the new comp's name)
newName	string	no	options: rename the comp to this; duplicate: name for the copy
comment	string	no	create, options: the comp's comment
visibility	boolean	no	create, options: record layer visibility
position	boolean	no	create, options: record layer position
appearance	boolean	no	create, options: record layer appearance (layer styles)

Make a new layer from existing pixels (Layer > New): Layer via Copy copies the selected pixels (or the whole layer when nothing is selected) to a new layer; Layer via Cut moves the selected pixels to a new layer; Stamp Visible merges a copy of every visible layer into a new layer above the target…

Parameter	Type	Required	Notes
method	string	yes	—
target		no	The one layer to copy or cut from, or to stamp above. Default the active layer
name	string	no	Name for the new layer

Select several layers at once in the Layers panel, for commands that act on the selected layers: set or add to the selection, select All Layers, Deselect Layers, Select Linked Layers, Similar Layers (same kind as the target), or find layers whose names contain some text (Select menu). Returns the…

Parameter	Type	Required	Notes
action	string	yes	set: select exactly the target layers; add: add them; all, none; linked and similar: start from the target layer; find: select layers whose name contains query
target		no	set and add: the layers; linked and similar: the layer to start from (default the active layer)
query	string	no	find: text the layer name contains, ignoring case

Run a command on every layer of the document: Delete Hidden Layers (Layers panel menu) or Rasterize All Layers (Layer > Rasterize > All Layers)

Parameter	Type	Required	Notes
action	string	yes	—

Apply locks to layers, optionally to every layer inside the target groups (Layer > Lock Layers, Lock All Layers in Group). Locks not listed are turned off; an empty list unlocks

Parameter	Type	Required	Notes
target		yes	—
locks	array	yes	all, pixels (image pixels), position, transparency (transparent pixels), artboard (prevent auto-nesting). [] unlocks
includeGroupContents	boolean	no	Also lock every layer inside target groups

Suspend a linked layer's link (the red X Shift-clicking the link icon shows) or restore it, without unlinking

Parameter	Type	Required	Notes
target		yes	—
enabled	boolean	yes	false suspends the link, true restores it

Change what the Layers panel shows, without changing the document: Isolate Layers (show only the target layers), Remove from Isolation, or Collapse All Groups

Parameter	Type	Required	Notes
action	string	yes	—
target		no	isolate: the layers to show. Default the active layer

Reverse the stacking order of two or more layers (Layer > Arrange > Reverse)

Parameter	Type	Required	Notes
target		yes	—

Clean the edge pixels of a pixel layer (Layer > Matting): Defringe (replace fringe colours over a width in pixels), Remove Black Matte, Remove White Matte, or Color Decontaminate

Parameter	Type	Required	Notes
method	string	yes	—
target		no	Pixel layers. Default the active layer
width	number	no	defringe: width in pixels. Default 1

Copy CSS for shape and type layers (size, position, colours, gradients, shadows, type settings), or SVG markup for a shape layer, to the clipboard (Layers panel context menu: Copy CSS, Copy SVG)

Parameter	Type	Required	Notes
target		no	Default the active layer
format	string	yes	—

Work with layer masks (Layer > Layer Mask and the Layers panel): add a mask (Reveal All, Hide All, Reveal Selection or Hide Selection), apply it to the pixels, delete it, disable or enable it, link or unlink it from the layer, invert it, target the mask or the layer content for editing, load the…

Parameter	Type	Required	Notes
action	string	yes	—
target		no	—
reveal	string	no	add: what the new mask shows. Default reveal_selection when there is a selection, otherwise reveal_all
showAlone	boolean	no	target_mask: show the mask by itself in the document window
invert	boolean	no	load_selection: select the hidden area instead
to	integer	no	copy_to, move_to: id of the layer that receives the mask; it must not have one

Set the Density (opacity) and Feather of a layer's layer mask, vector mask or smart-filter mask (Properties panel, masks)

Parameter	Type	Required	Notes
target		no	—
mask	string	no	Which mask. Default layer
density	number	no	Percent
feather	number	no	Pixels

Work with vector masks (Layer > Vector Mask): make one from a path (Current Path), disable or enable it, or delete it. Rasterize a vector mask with rasterize_layers

Parameter	Type	Required	Notes
action	string	yes	—
target		no	—
path	string	no	create_from_path: the path's name in the Paths panel. Default the selected path or work path

Clip layers to the layer below them (Layer > Create Clipping Mask), so they show only where it has pixels, or release them (Layer > Release Clipping Mask)

Parameter	Type	Required	Notes
target		yes	—
action	string	yes	—

Turn Quick Mask Mode on (the selection becomes a red overlay that painting edits) or off (the overlay becomes the selection again)

Parameter	Type	Required	Notes
enabled	boolean	yes	true enters Quick Mask Mode, false leaves it

Refine a layer mask's edges as Select and Mask does, writing the result back to the layer mask. Without a mask, the current selection is refined into a new mask

Parameter	Type	Required	Notes
target		no	One layer. Default the active layer
radius	number	no	Edge detection radius in pixels. Default 0
smartRadius	boolean	no	Smart Radius
smooth	integer	no	Default 0
feather	number	no	Pixels. Default 0
contrast	number	no	Percent. Default 0
shiftEdge	number	no	Percent; negative moves the edge in. Default 0

Make a layer's mask from a colour range (Properties panel, masks: Color Range): a sampled colour with a fuzziness, or a preset range such as reds, highlights or skin tones. Replaces the layer's existing mask

Parameter	Type	Required	Notes
target		no	One layer. Default the active layer
colors	string	no	Default sampled
color		no	sampled: the colour to keep. …
fuzziness	integer	no	sampled: how far from the colour still counts. Default 40
invert	boolean	no	Mask out the range instead of keeping it

Select a rectangle, an ellipse, a polygon or freehand outline (the Polygonal Lasso and Lasso tools), or a one-pixel row or column (Single Row and Single Column Marquee tools), in pixels from the document's top-left corner, combined with the current selection. The ellipse is a fine polygon, so its…

Parameter	Type	Required	Notes
shape	string	no	Default rectangle
bounds		no	Rectangle or ellipse bounds
points	array	no	Polygon or lasso outline, [[x, y], ...]
y	number	no	row: the row's top edge, pixels from the top
x	number	no	column: the column's left edge, pixels from the left
combine		no	—
feather	number	no	Pixels. Default 0
antiAlias	boolean	no	—

Select the whole canvas (Select > All), deselect (Select > Deselect), or invert the selection (Select > Inverse)

Parameter	Type	Required	Notes
action	string	yes	—

Modify the selection (Select > Modify): expand, contract, feather, smooth or border by pixels; grow or select similar colours by tolerance

Parameter	Type	Required	Notes
operation	string	yes	—
amount	number	yes	Pixels (radius or width); tolerance 0-255 for grow and similar

Move, scale or rotate the selection outline (Select > Transform Selection), or the selected pixels themselves

Parameter	Type	Required	Notes
pixels	boolean	no	Transform the selected pixels, not just the outline. Default false
dx	number	no	—
dy	number	no	—
scaleX	number	no	Percent
scaleY	number	no	Percent
angle	number	no	—

Fill the selection on the active layer with a colour (Edit > Fill), with a blend mode, opacity and optionally preserving transparency

Parameter	Type	Required	Notes
color		no	—
blendMode	string	no	Default normal
opacity	number	no	—
preserveTransparency	boolean	no	—

Stroke the selection's edge on the active layer (Edit > Stroke): colour, width in pixels, inside, centre or outside, blend mode and opacity

Parameter	Type	Required	Notes
color		no	—
width	number	yes	—
location	string	no	Default center
blendMode	string	no	Default normal
opacity	number	no	—
preserveTransparency	boolean	no	—

Store the selection in an alpha channel (Select > Save Selection), or load a channel as the selection (Select > Load Selection), combined with the current one

Parameter	Type	Required	Notes
action	string	yes	—
channel	string	yes	Alpha channel name. Saving to a new name creates the channel
combine		no	—
invert	boolean	no	Load: invert the channel. Default false

Copy, copy merged, cut or clear the selection on the active layer, or paste as a new layer: paste, paste_into the selection, paste_in_place (Edit > Paste Special > Paste in Place: at the copied pixels' original position) or paste_outside the selection (Paste Outside: the selection is masked out)

Parameter	Type	Required	Notes
action	string	yes	What to do

Choose a tool in the Tools panel, such as a marquee, lasso, Quick Selection, Magic Wand, Crop, Perspective Crop, Eyedropper, Color Sampler, Ruler or Count tool, so it is ready for the user. Using a tool on the canvas is the user's; select_area, crop_image and manage_count_items do the same work by…

Parameter	Type	Required	Notes
tool	string	yes	—

Select by colour (Select > Color Range): pixels near a sampled colour within a fuzziness, or a preset range (reds ... magentas, highlights, midtones, shadows, out of gamut), optionally inverted. Works inside the current selection when there is one, and samples the active layer

Parameter	Type	Required	Notes
color		no	—
preset	string	no	A preset range instead of a colour
fuzziness	integer	no	Sampled colours and highlights/midtones/shadows: how far from the colour or tone still counts. Default 40
range	array	no	highlights, midtones or shadows: the [lower, upper] tonal limits, 0-255
invert	boolean	no	Select everything else. Default false

Select automatically: the main subject (Select > Subject), the sky (Select > Sky), or the in-focus areas with Focus Area's automatic settings (Select > Focus Area). Subject uses the device or cloud processing chosen in Preferences > Image Processing

Parameter	Type	Required	Notes
what	string	yes	—
sampleAllLayers	boolean	no	subject and sky: look at every layer, not only the active one. Default false

Refine the selection's edge as Select and Mask does, without opening the workspace: edge detection radius (optionally smart), smooth, feather, contrast, shift edge and colour decontamination, output to the selection, a layer mask, a new layer or a new document

Parameter	Type	Required	Notes
radius	integer	no	Edge detection radius, pixels. Default 0
smartRadius	boolean	no	Smart Radius. Default false
smooth	integer	no	Default 0
feather	number	no	Pixels. Default 0
contrast	number	no	Percent. Default 0
shiftEdge	number	no	Percent; negative moves the edge inward. Default 0
decontaminate	boolean	no	Decontaminate Colors (needs an output to a new layer or document). Default false
decontaminateAmount	number	no	Percent. Default 100
sampleAllLayers	boolean	no	Default false
output	string	no	Default selection

Load layers' transparency as the selection, as Cmd/Ctrl-clicking a layer thumbnail does: replace, add to, subtract from or intersect with the current selection. With several layers, replace selects all of their pixels together

Parameter	Type	Required	Notes
target		yes	—
combine		no	—

Add a type layer: point type at a position, or paragraph type in a box (width and height), with its font, size, colour and formatting. Line breaks in text start new paragraphs

Parameter	Type	Required	Notes
text	string	yes	—
x	number	yes	Pixels from the left: the baseline start for point type, the box's left edge for paragraph type
y	number	yes	Pixels from the top
width	number	no	Paragraph type: box width in pixels
height	number	no	Paragraph type: box height in pixels
name	string	no	—

Change a type layer's text and/or formatting (applied to the whole layer), its position, and its warp (Type > Warp Text)

Parameter	Type	Required	Notes
target		yes	—
text	string	no	—
x	number	no	—
y	number	no	—
warp	string	no	—
warpBend	number	no	—
warpHorizontalDistortion	number	no	—
warpVerticalDistortion	number	no	—

List installed fonts with their PostScript name, family and style, filtered by a search string

Parameter	Type	Required	Notes
query	string	no	—
limit	integer	no	—

Set Character and Paragraph panel options on type layers: anti-aliasing, text and warp orientation (vertical type), kerning, language, No Break, OpenType ligatures and oldstyle figures, the paragraph type box size, indents, paragraph spacing, hyphenation, justification spacing, hanging punctuation…

Parameter	Type	Required	Notes
target		yes	—

Convert type layers (Type menu): to paragraph or point type, to a shape layer (Convert to Shape), to a work path (Create Work Path, which replaces the current work path), or to a selection shaped like the text, as the Type Mask tools make

Parameter	Type	Required	Notes
target		yes	—
to	string	yes	What to convert the type into
combine	string	no	selection: how the text outline combines with the current selection. Default replace
removeLayer	boolean	no	selection: delete the type layers afterwards, leaving only the selection (as the Type Mask tools do). Default false

Find and replace text in type layers (Edit > Find and Replace Text), keeping each layer's formatting. Searches every visible, unlocked type layer, or one layer. Line breaks in the replacement start new paragraphs

Parameter	Type	Required	Notes
find	string	yes	Text to find
replace	string	yes	Replacement text; empty deletes the matches
target		no	Search only this type layer instead of all of them (one layer)
caseSensitive	boolean	no	Match case. Default false
wholeWord	boolean	no	Whole words only. Default false
ignoreAccents	boolean	no	Ignore accents. Default false

Run a Type menu command: Update All Text Layers (also updates legacy and Asian text layers for vector output), Replace All Missing Fonts, Save Default Type Styles or Load Default Type Styles

Parameter	Type	Required	Notes
command	string	yes	The Type menu command

Fill type with an image: move an image layer directly above a type layer and clip it to the type (Layer > Create Clipping Mask), so the image shows only through the letters

Parameter	Type	Required	Notes
target		yes	The type layer (one layer)
image		yes	The image layer to show through the type (one pixel or smart object layer)

Show or hide a type panel (Window > Character, Paragraph, Character Styles or Paragraph Styles). Each call switches the panel between shown and hidden

Parameter	Type	Required	Notes
panel	string	yes	The panel to show or hide

Align layers by their top, vertical centre, bottom, left, horizontal centre or right edges (Layer > Align), or distribute them evenly by those edges (Layer > Distribute; three or more layers). With toSelection, align them to the selection (Layer > Align Layers To Selection)

Parameter	Type	Required	Notes
target		yes	—
edge	string	yes	—
distribute	boolean	no	Distribute instead of align. Default false
toSelection	boolean	no	Align to the current selection. Default false; Photoshop aligns to a selection whenever there is one, so without toSelection the call refuses when something is selected

Line up overlapping photos of the same scene (Edit > Auto-Align Layers) by their content, with the Auto or Perspective projection, optionally removing vignetting and correcting geometric distortion. Pixel layers only: not adjustment, vector or Smart Object layers

Parameter	Type	Required	Notes
target		yes	—
projection	string	no	Default auto
removeVignette	boolean	no	Vignette Removal. Default false
geometricDistortion	boolean	no	Geometric Distortion correction. Default false

Blend aligned layers into one seamless image (Edit > Auto-Blend Layers): a panorama, or a focus stack that keeps the sharpest areas of each layer, with Seamless Tones and Colors. RGB or Grayscale; not for Smart Objects, video, 3D or the background layer

Parameter	Type	Required	Notes
target		yes	—
method	string	no	Default panorama
seamlessTones	boolean	no	Seamless Tones and Colors. Default true

Transform layers or a path numerically, as Free Transform's options bar does: move, scale, rotate and skew (Edit > Transform > Skew) around a reference point; repeat the last transform (Edit > Transform > Again); or transform a duplicate, keeping the original. With path, transforms the path's…

Parameter	Type	Required	Notes
target		no	—
path	string	no	A path name (Paths panel) to transform instead of layers
dx	number	no	Move right, pixels
dy	number	no	Move down, pixels
scaleX	number	no	Width, percent; negative flips
scaleY	number	no	Height, percent; negative flips
angle	number	no	Degrees, clockwise
skewX	number	no	Horizontal skew, degrees
skewY	number	no	Vertical skew, degrees
anchor		no	—
again	boolean	no	Repeat the last transform instead of giving values (Transform Again)
duplicate	boolean	no	Layers: transform a copy of each layer, placed above it. Default false

Warp layers with a preset style (Edit > Transform > Warp): arc, arch, bulge, flag, wave, fisheye, twist and the rest, with bend and horizontal and vertical distortion in percent, horizontal or vertical. Warping a Smart Object stays editable

Parameter	Type	Required	Notes
target		yes	—
style	string	yes	—
bend	number	no	Percent. Default 50
horizontalDistortion	number	no	Percent. Default 0
verticalDistortion	number	no	Percent. Default 0
orientation	string	no	Default horizontal

Correct or change a layer's perspective (Edit > Perspective Warp) with one quad: four corners in the image move to four new positions, e.g. to square up a photographed sign. Corners go top-left, top-right, bottom-right, bottom-left, in pixels. Needs the graphics processor enabled

Parameter	Required	Notes
target	yes	One layer
from	yes	The quad's corners in the image now, [[x, y] x 4]
to	yes	Where those corners go, [[x, y] x 4]

Resize a layer while keeping important content such as people and buildings unchanged (Edit > Content-Aware Scale): width and height in percent, the Amount of content-aware against normal scaling, Protect Skin Tones, and an alpha channel to protect

Parameter	Type	Required	Notes
target		yes	One layer
scaleX	number	no	Width, percent. Default 100
scaleY	number	no	Height, percent. Default 100
amount	number	no	Percent of content-aware scaling. Default 100
protectSkinTones	boolean	no	Default false
protectChannel	string	no	Alpha channel whose white areas are protected (list_channels)
anchor		no	—

Draw with the shape and pen tools: rectangles (with rounded corners), ellipses, triangles, polygons, stars, lines, custom shape presets and pen points, combined with path operations. Mode shape makes a shape layer filled with a colour; path adds a path to the Paths panel; pixels fills the shape on…

Parameter	Type	Required	Notes
components	array	yes	The shape's components, drawn in order; each one's operation combines it with those before it
mode	string	no	Tool mode: shape layer (default), path, or pixels
color		no	Fill colour for shape and pixels modes. Default: the foreground colour
name	string	no	Name of the new shape layer, or of the new path (default "Path", numbered if taken)
opacity	number	no	pixels: fill opacity percent. Default 100
antiAlias	boolean	no	pixels: smooth the edges. Default true

List the Paths panel: each path's index, name and kind (saved path, work path, clipping path, vector or type mask) and its number of components; optionally every component's anchor points and direction handles, in pixels

Parameter	Type	Required	Notes
points	boolean	no	Include each component's operation, closed state and anchor points. Default false

Paths panel commands: rename, duplicate or delete a path; select or deselect it (Path Selection); load it as a selection (Make Selection); make a work path from the selection (Make Work Path); make it the clipping path; fill or stroke it on the active layer; save it as a custom shape preset (Edit…

Parameter	Type	Required	Notes
action	string	yes	The command
newName	string	no	rename: the new name; duplicate: the copy's name; define_custom_shape: the preset name
feather	number	no	make_selection and fill: feather radius in pixels. Default 0
antiAlias	boolean	no	make_selection and fill: anti-aliased edges. Default true
combine	string	no	make_selection: how it combines with the current selection. Default replace
tolerance	number	no	make_work_path: tolerance in pixels (lower follows the selection more closely). Default 2
flatness	number	no	make_clipping_path: flatness in device pixels. Default: the printer's
color		no	fill: colour. Default: the foreground colour
opacity	number	no	fill: opacity percent. Default 100
preserveTransparency	boolean	no	fill: leave transparent pixels transparent. Default false
tool	string	no	stroke: the painting tool, with its current settings. Default brush
simulatePressure	boolean	no	stroke: taper the stroke as pen pressure would. Default false

Edit a path's anchor points, as the Add Anchor Point, Delete Anchor Point, Convert Point and Direct Selection tools do: add a point (splitting a segment in half without changing its shape, or at a position), delete one, move a point or its direction handles, convert it between smooth and corner,…

Parameter	Type	Required	Notes
component	integer	no	Component (subpath) index from list_paths. Default 0
operation	string	yes	The edit
point	integer	no	Point index in the component. add_point: without x and y, splits the segment after this point; with them, inserts the new point at this index
x	number	no	add_point and move_point: anchor position, pixels from the left
y	number	no	add_point and move_point: anchor position, pixels from the top
handleIn		no	Direction point of the arriving segment, pixels
handleOut		no	Direction point of the leaving segment, pixels
smooth	boolean	no	add_point with x and y: make a smooth point. Default false
kind	string	no	convert_point: smooth computes handles from the neighbouring points unless handles are given; corner retracts the handles unless handles are given
pathOperation	string	no	set_operation: combine, subtract, intersect or exclude

Describe the document's timeline (Timeline panel): frame rate, playhead time, duration and work area when Photoshop reports them, the frame count in frame animation mode, and the video layers

No parameter schema on file.

Create a video timeline or a frame animation for the document, or convert between the two (Timeline panel: Create Video Timeline, Create Frame Animation, Convert to Frame Animation, Convert to Video Timeline)

Parameter	Type	Required	Notes
mode	string	yes	video (new video timeline), frames (new frame animation), convert_to_frames or convert_to_video
frameRate	number	no	Frame rate for a new or converted video timeline, in frames per second

Set the timeline: show or hide the Timeline panel, set the frame rate (Set Timeline Frame Rate), move the playhead to a time or Go To a frame or the work area, and choose the Layers panel's Animation Options

Parameter	Type	Required	Notes
panel	string	no	Show or hide the Timeline panel (Window > Timeline)
frameRate	number	no	Timeline frame rate in frames per second
time		no	—
goTo	string	no	Move the playhead instead: first or last frame, one frame or one second forward or back, or the work area start or end
animationOptions	string	no	Layers panel Animation Options: automatic, always_show or always_hide the unified layer buttons

Run a video timeline command on the selected clips, keyframes or video layer at the playhead (Timeline panel menu: Move & Trim, Split at Playhead, Work Area, Keyframes, Convert Frames, Enable Onion Skins, Show; Layer > Video Layers: Insert, Delete, Duplicate, Reload or Restore Frame, Hide Altered…

Parameter	Type	Required	Notes
command	string	yes	The command to run
target		no	Clips (layers) to select first. Default: the current selection

Edit a frame animation (Timeline panel in frame mode): new, delete, copy, paste, reverse or tween frames, select a frame, make frames from layers, flatten frames into layers, match a layer across frames, delete the animation, and the New Layers options. Tween and Paste Frames use the dialog's last…

Parameter	Type	Required	Notes
command	string	yes	The command to run on the selected frames
frame	integer	no	For select_frame: the frame number, 1 for the first
matchPosition	boolean	no	For match_layer: match the active layer's position. Default true
matchVisibility	boolean	no	For match_layer: match its visibility. Default true
matchStyle	boolean	no	For match_layer: match its layer style. Default true

Add a blank video layer above the active layer, for frame-by-frame painting (Layer > Video Layers > New Blank Video Layer)

Parameter	Type	Required	Notes
name	string	no	Name for the new layer

Import a video file's frames as layers of a new document, optionally as a frame animation (File > Import > Video Frames to Layers)

Parameter	Type	Required	Notes
file	string	yes	Absolute path of the video file
startTime		no	—
endTime		no	—
frameRate	number	no	The video's frame rate, which the frames in startTime and endTime count in. Default 30
frameSkip	integer	no	Keep every Nth frame (Limit To Every N Frames)
makeAnimation	boolean	no	Make a frame animation from the layers. Default false

Move the in or out point of clips (layer duration bars) in the video timeline, or set their duration

Parameter	Required	Notes
target	yes	—
moveIn	no	—
moveOut	no	—
duration	no	—

Add a transition (Fade, Cross Fade, Fade With Black or Fade With White) where two adjacent clips meet in the video timeline (Timeline panel transitions)

Parameter	Type	Required	Notes
target		yes	The two adjacent clips (layers) to join
type	string	no	fade, cross_fade, fade_black or fade_white. Default cross_fade
duration		no	—

Render the timeline to a video file through Adobe Media Encoder (File > Export > Render Video), at the document size

No parameter schema on file.

Add an adjustment layer above the active layer (Layer > New Adjustment Layer, or the Adjustments panel), with its settings, optionally clipped to the layer below. Adjustment layers change the look of the layers beneath without changing their pixels. Options by type: …. Color Lookup is created with…

Parameter	Type	Required	Notes
type	string	yes	Adjustment type
options		no	—
above		no	Add it above this layer (the first match) instead of the active layer

Change the settings of existing adjustment layers (the Properties panel). Only the options given change; the rest keep their values. Also sets name, opacity, blend mode and clipping. Options by type: ….

Parameter	Type	Required	Notes
target		yes	Adjustment layers of the given type
type	string	yes	Their adjustment type
options		no	—

Add a fill layer above the active layer (Layer > New Fill Layer): a solid colour, a gradient (defined as in the Gradient Editor) or a pattern, optionally clipped to the layer below. Options by type: ….

Parameter	Type	Required	Notes
type	string	yes	Fill type
options		no	—
above		no	Add it above this layer (the first match) instead of the active layer

Change existing fill layers: colour, gradient and its placement, or pattern (double-clicking the layer thumbnail). Only the options given change. Options by type: ….

Parameter	Type	Required	Notes
target		yes	Fill layers of the given type
type	string	yes	Their fill type
options		no	—

Set the document's measurement scale (Image > Analysis > Set Measurement Scale): how many pixels make a length in logical units, e.g. 100 pixels = 2 millimeters. Without arguments, returns the current scale

Parameter	Type	Required	Notes
pixelLength	number	no	Pixels
logicalLength	number	no	The length those pixels stand for
logicalUnits	string	no	Unit name, e.g. "mm", "microns", "km"
name	string	no	Name for this scale preset
reset	boolean	no	Reset to the default: 1 pixel = 1 pixel

Record measurements to the Measurement Log (Image > Analysis > Record Measurements) from the selection, the Ruler tool's line or the Count tool's items, with a chosen set of data points. The ruler source needs a line drawn with the Ruler tool

Parameter	Type	Required	Notes
source	string	no	What to measure. Default selection
dataPoints		no	—

Work with the Measurement Log panel (Window > Measurement Log): export all or the selected measurements to a tab-delimited text file, delete them, select or deselect all rows, toggle Auto Display Panel, or show or hide the panel

Parameter	Type	Required	Notes
action	string	yes	—
range	string	no	export and delete: all rows or the selected ones. Default all
filePath	string	no	export: absolute path of a .txt or .csv file
dataPoints		no	—

List, add, remove or clear the Count tool's numbered markers (count items) in the document. Positions are pixels from the top-left corner; indexes start at 0

Parameter	Type	Required	Notes
action	string	yes	—
points	array	no	add: positions, [[x, y], ...]
index	integer	no	remove: the count item's index

List the Channels panel: each channel's name, kind (component, alpha masked or selected areas, spot colour), visibility, opacity or spot solidity, colour, and whether it is targeted

No parameter schema on file.

Add an alpha channel (Channels panel > New Channel) whose colour shows masked or selected areas, or a spot colour channel (New Spot Channel) with its ink colour and solidity; optionally filled from the selection (Save Selection as Channel)

Parameter	Type	Required	Notes
name	string	no	Channel name; spot channels are usually named after the ink
kind	string	no	Default masked_areas (an alpha channel)
color		no	—
opacity	number	no	Overlay opacity of an alpha channel, or Solidity of a spot channel, percent
fromSelection	boolean	no	Fill the channel from the current selection. Default false

Change a channel's options (Channels panel > Channel Options): name, kind (converting an alpha channel to a spot channel or back), colour, opacity or solidity, and show or hide it (the eye icon). Colour channels such as Red can only be shown or hidden

Parameter	Type	Required	Notes
channel	string	yes	The channel's current name (list_channels)
name	string	no	—
kind	string	no	—
color		no	—
opacity	number	no	Percent
visible	boolean	no	—

Target channels for editing (clicking them in the Channels panel), duplicate a channel (into this or another open document), delete alpha or spot channels, or merge spot channels into the colour channels (Merge Spot Channel, which flattens the image)

Parameter	Type	Required	Notes
action	string	yes	—
channels	array	yes	Channel names (list_channels)
name	string	no	duplicate: name for the copy (one channel)
toDocument	string	no	duplicate: an open document of the same pixel size to copy into. Default this one

Split the image into one grayscale document per channel (Channels panel > Split Channels). The original closes; the image must be flattened first (flatten_image)

No parameter schema on file.

Combine open grayscale documents of the same pixel size into one image (Channels panel > Merge Channels): three into RGB or Lab, four into CMYK, or two or more into Multichannel, in channel order (e.g. red, green, blue)

Parameter	Type	Required	Notes
documents	array	yes	Open grayscale document names, in channel order
mode	string	no	Default rgb

Blend a source layer and channel, from this or another open document of the same pixel size, into the active layer (Image > Apply Image), with a blending mode, opacity, invert and preserve transparency; add and subtract take scale and offset. Works inside the selection when there is one

Parameter	Type	Required	Notes
target		no	The layer to change. Default the active layer
source		no	—
blendMode	string	no	Default normal
opacity	number	no	Percent. Default 100
preserveTransparency	boolean	no	Default false
scale	number	no	add and subtract: divide the result by this. Default 1
offset	integer	no	add and subtract: add this brightness. Default 0

Blend two source channels into a new alpha channel (Image > Calculations): each source is a layer (or merged) and channel, from this or another open document of the same pixel size, optionally inverted; with a blending mode and opacity

Parameter	Type	Required	Notes
source1		yes	—
source2		yes	—
blendMode	string	no	Default multiply
opacity	number	no	Percent. Default 100
name	string	no	Name for the new channel

Switch the foreground and background colours (Switch Foreground and Background Colors, X), or with reset: true return them to black and white (Default Foreground and Background Colors, D)

Parameter	Type	Required	Notes
reset	boolean	no	Reset to black foreground and white background instead of switching. Default false

Work with a colour the way the Color Picker and Color panel do: give a colour in any model (or read the current foreground or background colour) and get its HSB, RGB, Lab, CMYK, grayscale and hex values, whether it is web-safe and the nearest web-safe colour (Only Web Colors); optionally snap it…

Parameter	Type	Required	Notes
color		no	The colour. …
from	string	no	Use the current foreground or background colour instead of color
webSafe	boolean	no	Snap to the nearest web-safe colour (Only Web Colors)
setAs	string	no	Make the result the foreground or background colour

Read pixel colours of the composite image at points (Color Sampler tool and Info panel), optionally making the first the foreground or background colour (Eyedropper tool) and keeping the samplers in the document

Parameter	Type	Required	Notes
points	array	yes	Pixel positions from the document's top-left
setAs	string	no	Make the first sampled colour the foreground or background colour (Eyedropper)
keep	boolean	no	Leave colour samplers at the points. Default false
clear	boolean	no	Remove the document's existing colour samplers first. Default false

Save the selection, an area or the whole image as a pattern (Edit > Define Pattern), for pattern fill layers and fills. The area must be a plain rectangle; without one, the selection is used, or the whole image when nothing is selected

Parameter	Type	Required	Notes
name	string	yes	Pattern name
bounds		no	Rectangle to use, in pixels; selected first and deselected afterwards

Assign a colour profile to the active document without converting its colour values (Edit > Assign Profile): a profile name, the working space, or none (Don't Color Manage). Use convert_profile to keep the appearance instead

Parameter	Type	Required	Notes
profile	string	yes	Profile name, e.g. "Adobe RGB (1998)", or "working" for the working space, or "none"

Choose the colour settings file (Edit > Color Settings, e.g. "North America General Purpose 2"), Dynamic Color Sliders (Color panel) and the Gamut Warning opacity (Preferences > Transparency & Gamut); returns the current values. With no arguments it only reads them

Parameter	Type	Required	Notes
settings	string	no	Name of a colour settings file (as in the Color Settings Settings menu)
dynamicColorSliders	boolean	no	Dynamic Color Sliders
gamutWarningOpacity	number	no	Gamut Warning opacity, percent

Soft-proof the active document: choose a Proof Setup preset (View > Proof Setup: working CMYK or one plate, legacy Mac RGB, sRGB, monitor RGB, colour-blindness types), and toggle View > Proof Colors and View > Gamut Warning. The toggles switch the current state, which scripts cannot read

Parameter	Type	Required	Notes
preset	string	no	Proof Setup preset
toggleProofColors	boolean	no	Toggle Proof Colors
toggleGamutWarning	boolean	no	Toggle Gamut Warning

Generative Fill (Edit > Generative Fill) inside the current selection: generate content from a prompt, or with an empty prompt remove what is selected and fill from the surroundings. Results go to a new Generative Layer. Needs a selection, Photoshop signed in to an Adobe account and an internet…

Parameter	Required	Notes
prompt	no	What to generate in the selection; empty or omitted to remove the selected content
contentType	no	—
seed	no	—

Generate Image (Edit > Generate Image): create an image from a text prompt as a new layer filling the active document. Needs Photoshop signed in to an Adobe account and an internet connection; uses generative credits

Parameter	Required	Notes
prompt	yes	—
contentType	no	—
seed	no	—

Harmonize a layer with the image beneath it (the Properties panel's Harmonize): match its light, colour and shadows to the background. Results go to a new layer. Needs Photoshop signed in to an Adobe account and an internet connection; uses generative credits

Parameter	Type	Required	Notes
target		no	The layer to harmonize (the first one given). Default the active layer
seed		no	—

List the History panel's states and snapshots, and which one is current

No parameter schema on file.

Step back (undo) or forward (redo) through the history, or go to a state by index. Undone steps stay available until something new is done

Parameter	Type	Required	Notes
steps	integer	no	Positive to undo, negative to redo. Default 1
toIndex	integer	no	Go to this history state instead

Save the current state as a History snapshot, so it can be returned to later

Parameter	Type	Required	Notes
name	string	no	—

Change the history: revert to the last save (File > Revert), delete a state or snapshot, clear the history, make a new document from a state, set the history brush source or pick the History Brush tool (History panel), or purge every document's history (Edit > Purge > Histories). Clearing and…

Parameter	Type	Required	Notes
operation	string	yes	—
index	integer	no	delete_state, set_brush_source: the state or snapshot (index from list_history). new_document: the state to copy. Default the current state

Read or set the history preferences: History Options (Automatically Create First Snapshot, Allow Non-Linear History, number of history states) and the History Log (Preferences > History & Content Credentials: on or off, saved to metadata, a text file or both, and how much it records)

Parameter	Type	Required	Notes
autoFirstSnapshot	boolean	no	Automatically Create First Snapshot
nonLinear	boolean	no	Allow Non-Linear History
states	integer	no	History states kept per document
log	boolean	no	Turn the History Log on or off
logTo	string	no	Where the log is saved
logFile	string	no	Absolute path of the log text file, for logTo file or both
logDetail	string	no	Edit Log Items: sessions only, concise or detailed

Read the active document's print settings (File > Print): the printer and the printers available, copies, colour handling, print space, rendering intent, position and scale, printing marks, functions and PostScript options

No parameter schema on file.

Change the active document's print settings (File > Print) without the dialog: printer, copies, colour handling (including separations), print space, rendering intent, black point compensation, hard proof, position and scale, printing marks, functions (emulsion down, negative, background, border,…

Parameter	Type	Required	Notes
background		no	Functions: page background colour. …
position	object	no	Position and scale on the page: centered, fit (scale to fit the media), or custom with x and y (pixels from the page's top-left) and scale (percent)

Print the active document with its print settings and no Print dialog (File > Print), or print one copy with the current settings (File > Print One Copy). Set the printer and options first with set_print_options

Parameter	Type	Required	Notes
oneCopy	boolean	no	Print One Copy with the current settings; the other options do not apply. Default false
source	string	no	Print the document's colours, or a hard proof of the Proof Setup. Default document
printSpace	string	no	Printer profile name. Default: the print settings' print space
renderingIntent	string	no	Default relative_colorimetric
blackPointCompensation	boolean	no	Default true

Add trapping to a CMYK document (Image > Trap): overlaps between adjacent colours that hide misregistration on press. The document must be in CMYK mode

Parameter	Type	Required	Notes
width	number	yes	Trap width in pixels

Bundle layers into one embedded smart object (Layer > Smart Objects > Convert to Smart Object), or convert a layer so filters applied to it stay editable as Smart Filters (Filter > Convert for Smart Filters)

Parameter	Type	Required	Notes
target		no	—
name	string	no	Name for the smart object layer

Describe smart object layers: whether they are linked or embedded, their source file, the layer comps of the placed document and which one shows, and their Smart Filters in order with whether each is on

Parameter	Type	Required	Notes
target		no	—

Smart object commands (Layer > Smart Objects): New Smart Object via Copy, Edit Contents (opens the source as the active document; save and close it to update the layer), Replace Contents, Export Contents, Relink to File (also resolves a broken link), Update Modified Content, Update All Modified…

Parameter	Type	Required	Notes
action	string	yes	—
target		no	One smart object layer. Default the active layer
file	string	no	Absolute path. replace_contents and relink: the source file to use; export_contents and convert_to_linked: the file to write
page	integer	no	replace_contents: page of a multi-page file (PDF, Illustrator)
comp	string	no	set_layer_comp: name of a layer comp in the placed document (get_smart_object_info lists them)

Render a multi-layer smart object with a statistical stack mode (Layer > Smart Objects > Stack Mode), for example median to remove moving objects or mean to reduce noise. Give several aligned layers and they are first converted into one smart object (an image stack)

Parameter	Type	Required	Notes
target		no	A smart object, or the layers to stack. Default the active layer
mode	string	yes	—

Turn one Smart Filter on a smart object, or all of them, off or on (the eye icons under the layer in the Layers panel)

Parameter	Type	Required	Notes
target		no	—
visible	boolean	yes	true shows, false hides
index	integer	no	Which filter, 1 = the first listed by get_smart_object_info. Default all

Check that Photoshop is reachable: platform, how the server addresses Photoshop, whether it is running, its version and open documents. Use this first when a call fails to connect

Parameter	Type	Required	Notes
probe	boolean	no	Ask Photoshop for its version and documents (starts Photoshop if it is not running). Default true

Play an action from the Actions panel by its name and set. Dialogs in the action stay closed and use their recorded settings

Parameter	Type	Required	Notes
action	string	yes	Action name, e.g. "Vignette (selection)"
set	string	yes	Action set name, e.g. "Default Actions"

Run your own ExtendScript in Photoshop and return its last expression. It runs unrestricted: it can change or delete anything and read or write files. Prefer the specific tools

Parameter	Type	Required	Notes
code	string	yes	ExtendScript (ES3) source

List the tools by area, or describe one tool's parameters

Parameter	Type	Required	Notes
tool	string	no	A tool name

Free

$0 forever

Every tool, no call limit
No card, and mcprush charges nothing for it
Source published under MIT
Runs on your machine — nothing of it reaches our gateway
Nothing to cap, because mcprush bills nothing

Nothing here is billable: mcprush charges nothing to install Adobe Photoshop MCP or to call it, at any volume.

ATrust score 99 / 100

Release 0.1.0 · scanned 20 Oct 2026

Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.

Threat score100

Client score99

Findings0 threat · 0 capability

Capabilityminimal

Coveragesource

Verificationrepo

Surface digest2bd15407fec082e6fb3a36c8e2947b0afcefaf466ac24cff0be122cee0a3088c

Score vectorthreat 100 → client 99

Term	Level	What it prices	Points
capability-exposure	minimal	capability blast radius (minimal) — client exposure if the model is manipulated	−0
verification-discount	repo	publisher verification (public source) — no provenance, but the source is public and inspectable	−1
coverage-honesty	source	inspection depth (source) — how much of the target the scan could see	−0

score = clamp(round(threatScore − E_cap − E_ver − E_cov), 0, 100). No model, no opinion, no network call at scoring time: the same methodology version against the same bytes always produces this number, and every line above is a field of the report rather than a summary of it.

What the scan could actually read

A grade is only as meaningful as its coverage, so the scanner publishes its own depth before it publishes its result.

Tool surfacenot available

Implementation sourceread

Package metadataread

Live transportnot available

No tools were enumerated, so prompt-injection, capability and toxic-flow analysis had no tool surface to inspect. To grade a package’s real runtime tools, scan the running server: --command "npx -y <package>".

Capability — what it could do if the model were manipulated

Tags derived from each tool’s schema and the implementation, not from what the tool calls itself. minimal is the level these add up to.

Tool	Capability tags	Why the tag was assigned
No per-tool rows for this release — see the note below.

No tool surface was enumerated, so there is nothing to attribute a capability to.

Toxic-flow graph

The lethal trifecta, checked as a graph rather than as a checklist: untrusted input, a sensitive source and an external sink have to meet before there is a path worth worrying about.

The public result for this release does not print the flow graph, so there is nothing to show here. That is not the same as "no paths were found": what the scan did read is above, under coverage.

Supply chain and provenance

Integrityfirst-seen

Surface digest2bd15407fec082e6

Scanned2026-10-20

This is the first scan of this surface here, so there is nothing yet to compare it against.

Every result on this tab comes from one deterministic pass over the published package — offline, rule by rule, and auditable line by line above. Same methodology version, same bytes, same score.

Adobe Photoshop MCP

What it does

Quickstart

Where are you running it?

Tool surface

What counts against your monthly calls

What the scan could actually read

Capability — what it could do if the model were manipulated

Toxic-flow graph

Supply chain and provenance

Release history

See also