Skip to main content
Glama

workspace_list

Retrieve a list of all available virtual filesystem workspaces to manage files and directories across multiple storage providers.

Instructions

List all workspaces.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • MCP server registration of the 'workspace_list' tool, which delegates to WorkspaceTools.workspace_list()
    @server.tool
    async def workspace_list():
        """List all workspaces."""
        return await workspace_tools.workspace_list()
  • Core handler logic for listing workspaces: syncs namespaces and returns list via WorkspaceListResponse
    async def workspace_list(self) -> WorkspaceListResponse:
        """
        List all workspaces.
    
        Returns:
            WorkspaceListResponse with list of workspaces
        """
        # Sync with namespaces first
        await self.workspace_manager._sync_namespaces()
        workspaces = self.workspace_manager.list_workspaces()
    
        return WorkspaceListResponse(workspaces=workspaces)
  • Pydantic schema for the response: contains list of WorkspaceInfo objects
    class WorkspaceListResponse(BaseModel):
        """Response from workspace list"""
    
        workspaces: list[WorkspaceInfo]
  • Pydantic schema for individual workspace information used in the list response
    class WorkspaceInfo(BaseModel):
        """Information about a workspace"""
    
        name: str
        provider_type: ProviderType
        created_at: datetime
        current_path: str = "/"
        mount_point: str | None = None
        is_mounted: bool = False
        metadata: dict[str, Any] = Field(default_factory=dict)
    
        model_config = {"use_enum_values": False}
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'List all workspaces,' which implies a read-only operation, but doesn't specify what 'all' means (e.g., accessible workspaces, all existing workspaces), whether there are pagination limits, or what the output format looks like. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 'List all workspaces' is extremely concise—just three words—and front-loaded with the core action. There's zero waste or unnecessary elaboration, making it easy to parse quickly. Every word earns its place by directly contributing to understanding the tool's purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete for effective use. It doesn't explain what information is returned (e.g., workspace names, IDs, statuses), how results are structured, or any limitations (e.g., only lists workspaces the user has access to). For a listing tool with no structured output documentation, this leaves the agent guessing about the tool's behavior and results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, meaning there are no parameters to document. The description doesn't need to add parameter semantics, so it meets the baseline expectation. No additional value is required here, and the description doesn't introduce any confusion about parameters.

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 'List all workspaces' clearly states the verb ('List') and resource ('workspaces'), making the purpose immediately understandable. It distinguishes from siblings like workspace_create or workspace_destroy by specifying a read-only listing operation. However, it doesn't explicitly differentiate from workspace_info, which might provide detailed information about a specific workspace, leaving some ambiguity.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to use workspace_list versus workspace_info (for detailed info on a single workspace) or workspace_mount/unmount (for managing workspace access). There's no context about prerequisites, such as whether the user needs to be in a specific workspace or have certain permissions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/IBM/chuk-mcp-vfs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server