Skip to main content
Glama

Workspace list files

workspace_list_files
Destructive

List the files in a source repository via an ephemeral AI workspace on the organisation's staging cluster. Shallow-clones the repo and returns the tracked file paths (bounded). Safe in ask mode: the sandbox job is throwaway and cannot modify existing infrastructure. Requires a configured staging cluster plus either application_id or repository ('owner/name' - an Application-linked repository or one of the cluster's tagged context repositories). Optional 'path' lists a subdirectory.

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

Input Schema

NameRequiredDescriptionDefault
pathNoOptional subdirectory (relative to the repo root) to list.
branchNoOptional branch to clone. Defaults to the context tag's branch, the Application's configured branch, or the repository's default branch.
repositoryNoRepository to clone in 'owner/name' form. Must be an Application-linked repository or one of the cluster's tagged context repositories; anything else is rejected with the allowed list.
application_idNoThe Application whose linked repository to clone and list. Provide this or 'repository'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior2/5

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

The description adds genuine mechanism detail beyond the annotations: it shallow-clones the repo, returns tracked paths only (bounded), and runs as a throwaway job. However, it asserts the sandbox 'cannot modify existing infrastructure' while the annotations declare readOnlyHint=false and destructiveHint=true, leaving the agent with two conflicting risk signals and no reconciliation of which to trust.

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 sentences, front-loaded with the action and mechanism, then prerequisites, then the optional path hint. The 'cannot modify existing infrastructure' clause is doing double duty as both reassurance and risk claim, which is the one place the wording could be tighter.

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?

With no output schema, the description carries the return burden and does so adequately by naming tracked file paths and flagging that results are bounded. For a four-parameter cloning tool, the remaining gap is the unresolved tension with the destructive annotation and the unquantified 'bounded' limit.

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 the schema already documents all four parameters, including branch fallback order and the repository allow-list. The description restates the repository constraint and that 'path' is an optional subdirectory, adding emphasis but little meaning beyond the schema; baseline 3 applies.

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?

The description states a concrete verb and resource ('List the files in a source repository') and adds the distinguishing mechanism ('via an ephemeral AI workspace on the organisation's staging cluster'), which separates it from a direct GitHub-style file listing. It stops short of naming any sibling tool, so an agent must infer the contrast from the mechanism alone.

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 gives real preconditions: a configured staging cluster and either application_id or a repository that is Application-linked or a tagged context repository. It also frames the safe context ('Safe in ask mode'), but never states when to prefer it over the GitHub listing or workspace_read_file siblings, so the choice is left to inference.

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.