Skip to main content
Glama

project_files_list

Read-onlyIdempotent

List every deployed file in the project — path, type (static/binary/function), size, last_modified. No file bytes. Cheap tree listing for "show me what's in there" before deciding what to pull.

project_file_read reads one file; project_export returns everything in one shot.

Example:

{ "project_id": "my-saas" }
// Returns: {
//   project_id: "my-saas-uuid", env: "prod",
//   files: [
//     { path: "index.html", type: "static", size: 4203, last_modified: "..." },
//     { path: "hero.jpg",   type: "binary", size: 82310, last_modified: "..." },
//     { path: "api/checkout.mjs", type: "function", size: 1244 }
//   ],
//   counts: { static: 8, binary: 2, functions: 5 }
// }

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": {
      "project_id": "<project_id>"
    },
    "name": "project_files_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
envNoWhich environment to list. Defaults to "prod" (live). Explicit "dev" requires hosted preview access for signed-in accounts on every plan.
preview_idNoExact current candidate of preview_session_id. Both fields are required together.
project_idYesProject ID, slug, subdomain, or 'default'.
preview_session_idNoExact open preview session paired with preview_id and env:"dev". It does not fall back to another source.

Output Schema

NameRequiredDescriptionDefault
okNo
dataNo
errorNo
messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds genuinely new context: no file bytes are returned, the call is cheap, and the response shape includes counts by type. It stops short of discussing pagination or size limits on very large projects.

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?

The core purpose and the sibling routing are front-loaded in the first two sentences. The embedded JSON example is longer than strictly necessary given an output schema exists, but it does illustrate the type field values concretely.

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 listing tool with full schema coverage and an output schema, the description covers purpose, cost, exclusions, and alternatives. Nothing an agent needs in order to call it correctly is missing.

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 100%, so env, preview_id, preview_session_id and project_id are already documented, including the dev/preview pairing rule. The description's example only illustrates project_id usage and adds no new parameter semantics, so the baseline 3 applies.

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 every deployed file in the project') plus the exact fields returned (path, type, size, last_modified). It explicitly distinguishes itself from project_file_read and project_export, so an agent can pick it without opening a schema.

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

Usage Guidelines5/5

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

Gives an explicit when-to-use ('show me what's in there' before deciding what to pull) and names both alternatives with their differing behavior (one file vs everything in one shot). No inference required.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources