Skip to main content
Glama

list_app_files

List an app's workspace files with paths, sizes, SHA-256 hashes, and totals to preview exactly what a deployment would include.

Instructions

List an app's workspace: paths, sizes, sha256 and totals.

    What this lists is exactly what ``deploy_app`` would build — the exclude
    rules are enforced at write time, not at deploy time. Bounded at 500
    files by construction, so there is no paging.
    

Input Schema

NameRequiredDescriptionDefault
nameYesName of an existing workspace (also the app name it deploys under). No workspace by that name is ``404 workspace.not_found``.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/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 burden and discloses output fields, the 500-file bound, no paging, and write-time exclusion semantics. It does not state auth/permission requirements or explicitly confirm read-only/no side effects.

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?

Three short sentences, front-loaded with what the tool returns and followed by the key constraints. No sentence repeats the name/title or wastes space.

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?

For a one-parameter list tool with no output schema and no annotations, the description explains returned contents, the file bound, no paging, and the deploy relationship. It still omits an explicit read-only/auth note, though the schema covers the parameter and 404 case.

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%, and the schema already documents the name parameter, existing workspace, deploy-name relationship, and 404 behavior. The description adds only "app's workspace" context, so the baseline 3 is appropriate.

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 an app's workspace") and enumerates returned fields (paths, sizes, sha256, totals). It references deploy_app to explain the relationship, but does not explicitly distinguish itself from read_app_file or write_app_files.

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?

Gives clear context that the listing mirrors deploy_app's build and that excludes are enforced at write time, so an agent can infer it is useful for inventory/preview. It does not explicitly name when to use it instead of read_app_file or list_app_templates, nor does it state exclusions.

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