Skip to main content
Glama

photoshop_get_document_info

Reads active Photoshop document and active-layer metadata without switching tabs; optionally verifies a document ID matches the active tab before returning JSON state.

Instructions

Read the active Photoshop document and active-layer metadata through Photoshop/UXP without painting or switching tabs. Use this when an open document is required; photoshop_get_state also supports checking whether a document exists, while photoshop_list_documents lists all open tabs. Returns a text response headed "Document info:" containing the JSON state snapshot (hasDocument, document and activeLayer metadata). Requires a working Photoshop/UXP connection and an active document; no active document returns isError=true with "Error getting document info: No active document". Optional document_id verifies that the expected document is already active and fails closed on a mismatch; it never activates that document.

Tool call template

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

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

Input Schema

NameRequiredDescriptionDefault
document_idNoOptional Photoshop document id from photoshop_get_state / photoshop_list_documents. When set, the tool verifies that this document is already active and fails closed if another tab is active. It never switches the active Photoshop document automatically.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.8.0-preview.1

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it states no painting or tab switching, describes the return text format and JSON contents, specifies the no-active-document error behavior, and explains that document_id verifies but never activates a document.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded and well organized, moving from purpose to usage to return value to error behavior. It is slightly dense and repeats some schema content, but every part remains useful for invocation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description appropriately explains the return value as a text response with JSON state snapshot. It also covers the key failure mode and the optional verification behavior, leaving no material gaps for an agent to call it correctly.

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

Parameters3/5

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

Schema description coverage is 100%, so the parameter is already well documented. The description repeats the verification and fail-closed semantics rather than adding new parameter-level meaning beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: reading active Photoshop document and active-layer metadata. It distinguishes itself from siblings by naming photoshop_get_state and photoshop_list_documents and explaining the difference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says to use this when an open document is required, names alternative tools for related checks, and clarifies the optional document_id verification behavior and mismatch failure.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.