Skip to main content
Glama

listFolder

List one level of a Pinata folder to retrieve its files and subdirectories with names, paths, sizes, and CIDs, plus the folder's own CID. Use it to browse folder contents page by page or inspect a subdirectory.

Instructions

List one level of a folder on Pinata (one uploaded with uploadFolder, or any other folder): its files and subdirectories with their names, paths, sizes and CIDs, plus the folder's CID, its root (the name every file path starts with) and whether files can still be added to it (appendable, appendable_until). Pass path to list a subdirectory, and next_page_token as pageToken for the next page.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "folderId": "<folderId>"
    },
    "name": "listFolder"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoSubdirectory to list, relative to the folder root, without the root name (e.g. images/2024). Defaults to the root.
limitNoMaximum number of entries to return (default 100, at most 1000)
networkNoNetwork the folder is on; when given, a folder on the other network is not found
folderIdYesID of the folder (the id returned by uploadFolder)
pageTokenNonext_page_token of the previous page

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does well: 'one level' discloses non-recursive semantics, and the return payload (folder CID, root, appendable, appendable_until) is described in enough detail that an agent knows what it gets back. It stops short of covering auth requirements, rate limits, or the default page size behavior, which leaves a modest gap for a completely unannotated tool.

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?

Purpose and scope are front-loaded in the first clause, and the second sentence covers the two optional parameters efficiently. The first sentence is long and comma-heavy, packing the entire return payload into one breath, but no sentence is dispensable.

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

Completeness4/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 must explain return values — and it does, listing every returned field including the folder-level metadata. Combined with the fully documented input schema, an agent has nearly everything needed; only the pagination loop termination and auth context are left implicit.

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 coverage is 100%, so all five parameters are already documented in the schema, including path examples, the 1-1000 limit range, and the network enum. The description adds only a small mapping hint ('next_page_token as pageToken') and reinforces subdirectory path usage, so the baseline of 3 is appropriate.

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?

The description opens with a specific verb and resource ('List one level of a folder on Pinata') and immediately enumerates what is returned: file/subdirectory names, paths, sizes, CIDs, the folder CID, root prefix, and appendable status. That level of specificity makes it clearly distinct from siblings like getFileById or searchFiles.

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

Usage Guidelines4/5

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

It states provenance ('one uploaded with uploadFolder, or any other folder') and gives concrete operating instructions for subdirectory listing via 'path' and paging via 'next_page_token as pageToken'. What's missing is explicit routing guidance — it never says when to prefer searchFiles or getFileById instead, nor any preconditions such as the folder existing on the specified network.

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