Skip to main content
Glama

ListWorkspaces

Read-onlyIdempotent

The workspaces the caller may reach, by name, 20 a page: each one's id, name, size and what is free, location, hostname and apps domain. With project_id, also which of them hold a project of that id (holding_project). Free figures and project counts are each machine's latest sample, read now: one that did not answer in time leaves them absent (incomplete). The one call that takes no workspace. A caller that reaches none is refused as a call naming no workspace is: NoMachine (no plan) or WorkspaceNotGranted.

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

Input Schema

NameRequiredDescriptionDefault
page_tokenNoA next_page_token. Empty = the first page.
project_idNoA project_id: holding_project then says which workspaces have a project of that id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the readOnly/idempotent annotations it discloses page size, the full per-workspace return fields, and a non-obvious data-freshness rule: free figures and project counts are each machine's latest sample, absent plus `incomplete` when a machine did not answer. It also names the two refusal errors, though the phrasing of those sentences is compressed and takes a second read.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is front-loaded and has no filler, but the prose is elliptical and run-on ('20 a page', 'read now: one that did not answer in time leaves them absent'), which slows parsing of otherwise high-value details. Information density is good; readability of individual clauses is not.

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?

With no output schema, the description carries the return-shape burden and does so: paging, exact fields, conditional holding_project, staleness semantics, and error outcomes. An agent has enough to call it correctly and interpret the response without further probing.

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 both parameters are already documented, including the holding_project behavior of project_id. The description restates that behavior and adds only the pagination size ('20 a page') and the NoMachine/WorkspaceNotGranted refusal modes, which are output/error semantics rather than new parameter meaning.

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 names the resource and its scope precisely: 'The workspaces the caller may reach', and enumerates what comes back per workspace (id, name, size, free, location, hostname, apps domain). The listing verb is implied rather than stated, and sibling differentiation is only partial ('The one call that takes no `workspace`'), which keeps it just short of a 5.

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

Usage Guidelines3/5

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

It gives an implicit condition for the optional parameter ('With project_id, also which of them hold a project of that id') and a negative scoping note that it is the only call without a `workspace` argument. It never says when to prefer this over GetProject or other enumeration tools, so usage is inferred rather than stated.

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