Skip to main content
Glama
owine

UniFi Protect MCP

by owine

List files

protect_list_files
Read-only

Lists device asset files for UniFi Protect animations uploaded to G4 Doorbell screens. Returns file metadata and supports limit/offset pagination for large sites.

Instructions

List device asset files (only 'animations' is supported — clips uploadable to G4 Doorbell screens). Returns array; each record (verified live 7.3.70): id, name (server-generated), type, originalName, path, size, createdAt, updatedAt, metadata. An image upload (verified for GIF) later gains a derived .gif preview record, created asynchronously, so a listing taken right after the upload may show only the stored image. On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

NameRequiredDescriptionDefault
limitNoReturn at most this many items
offsetNoSkip this many items first (default 0)
fileTypeYesAsset file type (only 'animations' is supported)

Output Schema

NameRequiredDescriptionDefault
offsetNoPaged results only: the index of the first item returned
resultYesArray of items returned by the list endpoint
totalCountNoPaged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv2.15.0
    • addedInput schema / properties / fileType / const
      Added value: +"animations"
    • changedInput schema / properties / fileType / description
      Previous value: -"File type to list (only 'animations' is currently supported)"New value: +"Asset file type (only 'animations' is supported)"
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Return at most this many items",
      +  "maximum": 9007199254740991,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Skip this many items first (default 0)",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedOutput schema / properties / offset
      Added value: +{
      +  "description": "Paged results only: the index of the first item returned",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / result / items / properties / createdAt
      Added value: +{
      +  "description": "Creation time (ISO 8601)",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / result / items / properties / id
      Added value: +{
      +  "description": "File ID (same value as name)",
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / items / properties / metadata
      Added value: +{
      +  "description": "Asset metadata (object, empty in observed records)"
      +}
    • changedOutput schema / properties / result / items / properties / originalName / description
      Previous value: -"Original uploaded file name"New value: +"Uploaded file name; Protect appends the stored extension, e.g. \"welcome.gif.png\""
    • addedOutput schema / properties / result / items / properties / size
      Added value: +{
      +  "description": "File size in bytes (number)"
      +}
    • addedOutput schema / properties / result / items / properties / updatedAt
      Added value: +{
      +  "description": "Last update time (ISO 8601)",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / totalCount
      Added value: +{
      +  "description": "Paged results only: the number of items in the whole list",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
  2. Changed8 schema fields changedv2.11.5
    • removedOutput schema / properties / result / items / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / originalName / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / originalName / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / path / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / path / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / type / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. Changed6 schema fields changedv2.7.5
    • removedOutput schema / properties / result / items / properties / id
      Removed value: -{
      -  "description": "File ID",
      -  "type": "string"
      -}
    • removedOutput schema / properties / result / items / properties / modelKey
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Resource kind"
      -}
    • changedOutput schema / properties / result / items / properties / name / description
      Previous value: -"File name"New value: +"Stored file name (server-generated)"
    • addedOutput schema / properties / result / items / properties / originalName
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Original uploaded file name"
      +}
    • addedOutput schema / properties / result / items / properties / path
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Server-side storage path"
      +}
    • addedOutput schema / properties / result / items / properties / type
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Asset file type, e.g. \"animations\""
      +}
  4. First observedv2.7.4

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, non-destructive, closed-world), yet the description adds real behavioral context: the asynchronous creation of a derived '<name>.gif' preview record, and the warning that a listing taken right after an upload may show only the stored image. The field enumeration ('verified live 7.3.70') is largely redundant given an output schema exists, which keeps this from a 5.

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?

Front-loaded with scope and constraint, then the async caveat, then paging guidance — a sensible ordering. It is dense but each clause carries information, except the enumerated record fields, which duplicate the output schema.

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?

For a read-only list tool with an output schema and full parameter coverage, the description supplies exactly the missing context: the single supported file type, the async derived-preview caveat, and how to paginate a large site. Nothing needed to invoke it correctly appears to be absent.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3. The description nevertheless adds meaning beyond the schema: that limit/offset are the paging mechanism and that a paged result additionally returns totalCount and offset, which is behavior the schema alone does not convey.

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 ('List device asset files') and immediately narrows the scope to a single supported type ('only animations is supported — clips uploadable to G4 Doorbell screens'). Sibling list tools all target different resources (cameras, lights, chimes), so naming this resource is sufficient to tell it apart.

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?

Gives conditional guidance on paging ('On a large site, use limit and offset to page'), which is useful and actionable. However it never states when to call this tool versus other listings or what the required fileType effectively forces, so usage remains implied rather than explicit.

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