Skip to main content
Glama

Search assets by metadata

immich_search_assets

Search Immich assets by metadata filters such as date, location, people, tags, type, rating, and camera details to find specific photos or videos.

Instructions

Search assets by metadata

Search for assets based on various metadata criteria.

Immich operation: POST /search/metadata · tag: Search

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoid (request body)
keyNo
ocrNoocr (request body)
cityNocity (request body)
makeNomake (request body)
pageNopage (request body)
sizeNosize (request body)
slugNo
typeNotype (request body)
modelNomodel (request body)
orderNoorder (request body)
stateNostate (request body)
cursorNocursor (request body)
filterNofilter (request body)
ratingNorating (request body)
tagIdsNotagIds (request body)
countryNocountry (request body)
orderByNoorderBy (request body)
albumIdsNoalbumIds (request body)
checksumNochecksum (request body)
isMotionNoisMotion (request body)
withExifNowithExif (request body)
isEncodedNoisEncoded (request body)
isOfflineNoisOffline (request body)
lensModelNolensModel (request body)
libraryIdNolibraryId (request body)
personIdsNopersonIds (request body)
isFavoriteNoisFavorite (request body)
takenAfterNotakenAfter (request body)
visibilityNovisibility (request body)
withPeopleNowithPeople (request body)
descriptionNodescription (request body)
previewPathNopreviewPath (request body)
takenBeforeNotakenBefore (request body)
withDeletedNowithDeleted (request body)
withStackedNowithStacked (request body)
createdAfterNocreatedAfter (request body)
isNotInAlbumNoisNotInAlbum (request body)
originalPathNooriginalPath (request body)
trashedAfterNotrashedAfter (request body)
updatedAfterNoupdatedAfter (request body)
createdBeforeNocreatedBefore (request body)
thumbnailPathNothumbnailPath (request body)
trashedBeforeNotrashedBefore (request body)
updatedBeforeNoupdatedBefore (request body)
encodedVideoPathNoencodedVideoPath (request body)
originalFileNameNooriginalFileName (request body)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

Annotations (readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false) do not cover this tool well, and the description adds nothing to compensate — it never explains why a read-like search is not read-only, whether results are paginated via the page/size/cursor params, or what the effective scope is. 'Immich operation: POST /search/metadata' is the only extra detail, essentially repeating structured metadata.

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

Conciseness3/5

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

It is short and front-loaded with the action, but the second line ('Search for assets based on various metadata criteria') merely restates the title and name without adding information. Compact but nearly content-free.

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

Completeness2/5

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

For a 47-parameter tool with a deeply nested filter schema (eq/ne/in/gt/lt/gte/lte, or-branches, visibility, etc.) and no output schema, this description is far too thin. An agent gets no help understanding the filter DSL, pagination, or result shape for a genuinely complex operation.

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 96%, so the schema already documents nearly every parameter, making 3 the baseline. The description adds nothing about the 47 parameters, including the large nested 'filter' object and its operator semantics, so it neither helps nor hurts.

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 specific verb+resource ('Search assets by metadata') and reinforces it with 'based on various metadata criteria', so the intent is unambiguous. However, it never distinguishes itself from the many search siblings (immich_search_smart, immich_search_random, immich_search_stacks, immich_search_asset_files), so an agent can't tell which search to pick from the description alone.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no mention of alternatives. With over a dozen search-related siblings, the definition gives no signal about which conditions select this metadata search versus semantic or random search, leaving the agent to guess.

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

Deploy Server

Other Tools