Skip to main content
Glama

list_workspace

Read-only

Lists folder entries one level deep as paths with directory flags and paging, so you can locate files before reading them; it does not read contents or list outside the chosen root.

Instructions

List the entries of one folder (single level, sorted by name) as path plus a directory flag, with has_more for paging. Read-only; credentials and managed metadata are hidden. Use it to find files, then read_workspace to read one. It never reads file contents and cannot list outside the chosen root.

Input Schema

NameRequiredDescriptionDefault
pathNoFolder relative to the root, for example 'src'. Empty lists the root.
limitNoMaximum entries to return, from 1 to 200.
offsetNoEntries to skip, for paging. Must be >= 0.
root_idNoWhich root to list: 'project' (the registered repository), 'worktree' (a task's recorded worktree, needs execution_id) or the id of a read root the operator granted.project
project_idYesRegistered project id, as returned by list_projects.
execution_idNoExecution id whose recorded worktree to read. Required when root_id is 'worktree'; ignored for other roots.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.1.3
    • addedInput schema / properties / execution_id / description
      Added value: +"Execution id whose recorded worktree to read. Required when root_id is 'worktree'; ignored for other roots."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum entries to return, from 1 to 200."
    • addedInput schema / properties / offset / description
      Added value: +"Entries to skip, for paging. Must be >= 0."
    • addedInput schema / properties / path / description
      Added value: +"Folder relative to the root, for example 'src'. Empty lists the root."
    • addedInput schema / properties / project_id / description
      Added value: +"Registered project id, as returned by list_projects."
    • addedInput schema / properties / root_id / description
      Added value: +"Which root to list: 'project' (the registered repository), 'worktree' (a task's recorded worktree, needs execution_id) or the id of a read root the operator granted."
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and destructiveHint=false, so the bar is lower, yet the description still adds real behavior: single-level listing, name sorting, has_more paging, and that credentials and managed metadata are hidden from results. That last point materially shapes what the agent should expect in the output.

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?

The description opens with what the tool returns, then the paging hint, then the safety/filtering note, then the sibling routing rule and limits. Every sentence adds distinct information with no restatement of the name.

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 an output schema that already documents return shape, the description covers the remaining gaps an agent needs: scope (single level, within root), paging, hidden entries, and the handoff to read_workspace.

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 each of the six parameters is documented in the schema itself, including path, limit/offset and root_id semantics. The description only alludes to 'one folder' and 'the chosen root' without adding syntax or constraints beyond the schema, so 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 plus scope details: 'List the entries of one folder (single level, sorted by name) as path plus a directory flag, with has_more for paging.' It also distinguishes itself from the sibling read_workspace by noting it never reads file contents.

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?

Explicitly routes the agent: 'Use it to find files, then read_workspace to read one,' and adds a negative constraint that it cannot list outside the chosen root. It stops short of explaining when to pick each root_id variant (project vs worktree vs operator-granted root), leaving that to the schema.

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