Skip to main content
Glama

List Images

list_images
Read-onlyIdempotent

List Brand Library images with pagination and filters, or read known image_ids together. For images that are pending or generating: image_url is absent.

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": "list_images"
  }
}

Input Schema

NameRequiredDescriptionDefault
waitNoHold the connection until every existing image record referenced by image_ids reaches a terminal status. Selected-model generation-job IDs are not resolved. Defaults to true when image_ids is provided, false otherwise. No-op when image_ids is omitted.
limitNoResults per page when browsing. Ignored when image_ids is provided.
cursorNoPass next_cursor from the previous result to get the next page.
sourceNoFilter by image source. "generated" = AI-created, "uploaded" = user uploads, "scraped" = website images from brand onboarding
statusNoFilter by generation status (only applies to generated images)
timeoutNoTime to wait for the requested image_ids to reach a terminal status, in seconds. Applies when waiting is enabled. Defaults to and is capped at 45 seconds.
image_idsNoFetch existing managed or Brand Library image IDs in one call. limit is ignored in this mode. Selected-model generation-job IDs are not accepted.
llm_modelNoThe model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics.
action_typeNoFilter by action type (only applies to generated images)
include_urlsNoIgnored — image URLs are always included because this tool has an attached UI widget that needs them to render. Kept in the schema for backward compatibility with existing callers.
workspace_idNoScope results to one workspace by id (from list_workspaces). Omit (or pass null) to span every workspace the caller can see — each result is labeled with its workspace.
brand_session_idNoBrand whose images to list. Omit to include all brands within the selected workspace scope.

Output Schema

NameRequiredDescriptionDefault
imagesYesImages on this page.
has_moreYesWhether more results follow this page.
brand_nameNoName of the brand, when available for a request filtered by brand_session_id.
next_cursorYesPass as cursor to get the next page. Null when no more results follow.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds a genuinely non-obvious output trait: image_url is absent for pending or generating images, which prevents an agent from treating a missing URL as an error. It omits the blocking wait/timeout behavior, but that is documented in the schema.

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

Conciseness5/5

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

Two short sentences, front-loaded with the primary operation and the two modes, followed by the one output caveat. Nothing is redundant or padded.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and the description covers both modes plus the missing-URL case. For a 12-parameter tool whose wait parameter can hold the connection up to the 45-second cap by default when image_ids is supplied, that latency behavior is a notable planning concern the description never mentions.

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 twelve parameters are already fully explained (wait semantics, cursor paging, source/status/action_type filters, workspace and brand scoping). The description only restates 'pagination and filters' generically and adds no syntax, defaults, or mode interactions beyond the schema.

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

Purpose4/5

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

States a concrete verb and resource ('List Brand Library images') and enumerates the two supported modes: paginated filtering versus batch read of known image_ids. It is clear what the tool does, but it never names which sibling to prefer for non-Brand-Library or free-text searches (e.g., search_user_images), so sibling differentiation is left implicit.

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

Usage Guidelines3/5

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

The 'or read known image_ids together' clause gives a mode-selection rule, so usage is at least implied. However there is no explicit when-not guidance, no mention that limit is ignored in image_ids mode (only the schema says this), and no routing to alternative tools for other image collections.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources