Skip to main content
Glama

list_workspaces

Lists discovered PBIP workspaces and optionally filters them by workspace name or path using a case-insensitive query.

Instructions

List discovered PBIP workspaces, optionally filtered by query.

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

Input Schema

NameRequiredDescriptionDefault
queryNoOptional case-insensitive filter on workspace name or path.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description bears the full disclosure burden; it does hint that results come from a prior discovery process ('discovered') rather than a live scan. However, it says nothing about whether results can be stale, what happens with an empty filter, or any permission requirements, leaving real behavioral gaps for a no-annotation tool.

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?

One short sentence that front-loads the verb and resource, with the optional filter noted at the end. No wasted words and nothing buried.

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?

This is a simple read-only listing tool with one optional parameter and an output schema that covers return values, so the description is nearly sufficient. The only shortfall is the absence of any note on data freshness or interaction with the workspace-discovery/refresh tools.

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 the single 'query' parameter is fully documented in the schema as a case-insensitive filter on name or path. The description only restates that filtering is optional, adding no syntax or matching details beyond the schema, so the 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 specific verb and resource ('List ... PBIP workspaces') and adds scope ('discovered'), so an agent immediately knows this is a discovery-listing tool. It does not explicitly distinguish itself from siblings like get_workspace or refresh_workspaces, which keeps it at a 4 rather than 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?

Usage is only implied by the verb 'list' and the optional filter — an agent can infer this is the entry point for enumerating workspaces. There is no explicit guidance on when to prefer get_workspace for a single workspace, whether a refresh is needed first, or any prerequisite conditions.

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