Skip to main content
Glama

ugreen_list_files

Read-onlyIdempotent

List files and folders in a personal or shared NAS root or any specified path, with paging, sorting, and limit controls. Use it to browse directory contents and retrieve file metadata.

Instructions

列个人/共享根目录或指定文件夹。默认列共享文件夹。使用一元 ls-root,兼容流式接口不可用的设备。文件数组在 data.data.file_list.files;保留 total/page 等官方字段。

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

Input Schema

NameRequiredDescriptionDefault
pageNo
pathNo
rootNoshared
sortNoname
limitNo
reverseNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds value beyond that: the default root is shared, the unary ls-root endpoint is used for device compatibility, and the file array's location in the response is data.data.file_list.files with official total/page fields preserved. It does not describe pagination limits or error behavior, so it is not 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?

Four short, front-loaded sentences with no wasted wording; the default scope comes first and the response-shape detail comes last. It is dense but each sentence adds information, so it is efficient rather than 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?

With no output schema, the description helpfully explains where the file array lives in the response. Still, for a six-parameter listing tool with 0% schema coverage, gaps remain around pagination (page/limit), sorting (sort/reverse), and any permission or error behavior.

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

Parameters2/5

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

Schema description coverage is 0% across six parameters, so the description carries the full burden. It clarifies the 'root' default (shared) and the meaning of 'path' (a specified folder), but says nothing about page, limit, sort, or reverse, leaving four parameters undocumented in both the schema and the description.

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 and resource: list the personal/shared root or a specified folder. It also names the default root (shared), which pins down the tool's default scope. It does not explicitly distinguish itself from siblings such as ugreen_search or ugreen_file_stat, so it falls short of a 5.

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?

Usage is implied by the description ('list a root or a folder, defaulting to shared'), and the note about the unary ls-root endpoint being compatible with devices where the streaming interface is unavailable gives operational context. However, there is no explicit guidance on when to choose this over ugreen_search, ugreen_file_stat, or ugreen_search_results, and no prerequisites or exclusions are stated.

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