Skip to content

Built-In Capability Matrix

The generator registers the built-in modules declared by packages/generator/src/modules/index.ts in the MODULES manifest. A directory under modules/ is not a published capability unless it is registered there.

This matrix records whether each logical capability has an official access surface:

  • SDK means a typed Connection.modules.* facade is available. Generic Connection.invoke(...) access does not count.
  • Plugin Host means the capability is part of the typed plugin.modules.* contract exported for plugin authors.
  • WS means the capability is registered as a WebSocket Protocol method.
  • HTTP API means the capability has a registered @api route.
  • MCP is unavailable in the current version. No built-in capability is exposed through MCP yet.

A check means the capability has an entry point on that surface. Parameters and result shapes can differ between surfaces; see SDK Modules, Protocol, and API Routes for the surface-specific contract.

Request Capabilities

CapabilitySummarySDKPlugin HostWSHTTP APIMCP
action.autoCutoutSelect the main subject of the current layer.
action.removeBackgroundRemove the background from the current layer.
document.getCurrentDocumentRead metadata for the active document.
document.exportDocumentExport the active document to a file.
document.saveDocumentSave the active document, optionally to a new path.
layer.getLayerInfoRead layer metadata with optional children and settings.
layer.getLayerInfoByIDRead layer metadata by Photoshop layer ID.
layer.getLayerInfoByIndexRead layer metadata by document layer index.
layer.getLayerInfoBySelectionIndexRead layer metadata by its index in the current selection.
layer.getCurrentPreviewRender a PNG preview for the current layer.
layer.importImageImport an image as a layer with optional placement settings.
image.exportLayerExport a layer or layer range as PNG image data.
image.exportLayerWithSelectedPathExport a layer using the current selected path.
image.getPreviewRender a PNG preview for a specified layer.
image.exportDocumentExport a document as PNG image data.
selection.watchEnable production of selection change events.
selection.getAreaRead the bounds of the current selection.
selection.getPathRead the current selection path as SVG geometry.

Event Capabilities

Module events use the typed SDK and Plugin Host event facades. Remote SDK subscriptions travel over WebSocket; events do not have HTTP or MCP entry points.

EventSummarySDKPlugin HostWSHTTP APIMCP
layer:previewChangePublishes the refreshed current-layer preview.
layer:selectionChangePublishes metadata for the selected Photoshop layers.
selection:changedPublishes the current selection bounds after changes.