Skip to main content
Glama

Search workspaces

search_workspaces
Read-only

Search and filter workspaces for a user. Input shape: member_user_id (required root param, auto-injected), filter_groups (optional), sort (optional), page (0-based, default 0), page_size (default 20, max 100). When filter_groups is omitted, returns all workspaces the user belongs to. field and operator are enums — always pass exact enum strings. Valid field→operator pairs: WORKSPACE_FILTER_FIELD_NAME→CONTAINS, EQUALS, or REGEX; WORKSPACE_FILTER_FIELD_WORKSPACE_ID→EQUALS or IN; WORKSPACE_FILTER_FIELD_DOMAIN→CONTAINS, EQUALS, or REGEX; WORKSPACE_FILTER_FIELD_WORKSPACE_TYPE→IN; WORKSPACE_FILTER_FIELD_CREATED_AT→GTE or LTE (ISO-8601); WORKSPACE_FILTER_FIELD_DESCRIPTION→CONTAINS. Returns workspace id, name, description, type, contact stats, config, logo, member count, and the user's roles.

Use when: Use for ANY workspace lookup for the current user. Decision guide — (1) List all workspaces: omit filter_groups (member_user_id only). (2) Find by name substring: WORKSPACE_FILTER_FIELD_NAME + WORKSPACE_FILTER_OPERATOR_CONTAINS e.g. ['acme']. (3) Find by name regex: WORKSPACE_FILTER_FIELD_NAME + WORKSPACE_FILTER_OPERATOR_REGEX e.g. ['^Acme.*']. (4) Lookup by workspace UUID: WORKSPACE_FILTER_FIELD_WORKSPACE_ID + WORKSPACE_FILTER_OPERATOR_EQUALS e.g. ['<uuid>']. (5) Bulk lookup by IDs: WORKSPACE_FILTER_FIELD_WORKSPACE_ID + WORKSPACE_FILTER_OPERATOR_IN e.g. ['uuid1','uuid2']. (6) Find by domain: WORKSPACE_FILTER_FIELD_DOMAIN + WORKSPACE_FILTER_OPERATOR_EQUALS e.g. ['acme.com'] or CONTAINS/REGEX for partial/pattern. (7) Filter by type: WORKSPACE_FILTER_FIELD_WORKSPACE_TYPE + WORKSPACE_FILTER_OPERATOR_IN e.g. ['CUSTOMER']. (8) Filter by creation date: WORKSPACE_FILTER_FIELD_CREATED_AT + GTE/LTE with ISO-8601 e.g. ['2024-01-01T00:00:00Z']. member_user_id is always required and scopes to that user's memberships.

Behavior: read_only

workspace_id / user_id are injected from request headers.

Returns workspaces[] with fields:

id: Unique UUID of the workspace. Use this as the workspace_id when calling other workspace-scoped APIs. name: Display name of the workspace. description: Free-text description of the workspace's purpose or customer context. May be empty. workspace_type: Tier or classification of the workspace. meta: Contact counts for the workspace: total, processable, unique, and discovered contacts. workspace_config: Workspace-level configuration values (category 'workspace'). Structured as a JSON object. May be empty if no custom configuration has been set. created_at: Timestamp when the workspace was first created. updated_at: Timestamp of the most recent update to the workspace record. is_disabled: True if the workspace has been disabled (soft-deleted or suspended). Disabled workspaces are not fully active; their data is retained but the workspace is not operational. logo_url: Public URL of the workspace's logo image. Empty string if no logo has been uploaded. active_member_count: Number of active (non-removed) members currently in the workspace. requesting_member_roles: Roles held by the requesting user in this workspace. A user can hold multiple roles simultaneously e.g. ['OWNER', 'SUPER_CONNECTOR_ADMIN']. Always non-empty since only workspaces where the user is an active member are returned. workspace_scope: Whether the workspace belongs to a company or to one person. package_type: The shape of the workspace's current plan. Unspecified when it has no subscription. Also returns pagination info (current_page, page_size, total_elements, total_pages, has_next, has_previous).

IMPORTANT: If the response contains more than one record, always present the options to the user and ask them to choose before taking any follow-up action. Do not act on all results automatically.

Input Schema

NameRequiredDescriptionDefault
pageNo
sortNoOrdered list of sort criteria. First entry is primary sort, subsequent entries break ties. Optional — defaults to NAME ascending (A-Z) if omitted.
page_sizeNo
filter_groupsNoOptional list of filter groups (AND-combined). Omit to return all workspaces for member_user_id. Each criterion uses enum field + enum operator + values array. See WorkspaceFilterCriterion for valid field→operator pairs and example values.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / properties / _triggered_by
      Removed value: -{
      -  "default": "",
      -  "description": "REQUIRED. Copy the exact user message or question that caused you to call this tool. Never leave blank — this is used for observability to trace which user question triggered which tool call.",
      -  "type": "string"
      -}
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds real value beyond them: it explains that member_user_id/workspace_id are auto-injected from headers, and the closing IMPORTANT rule about not auto-acting on multi-record results is genuine behavioral guidance. It stops short of covering rate limits or empty-result behavior.

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?

The front-loaded input shape is good, but the entry is bloated: the field→operator pair list is duplicated verbatim in the schema, and every return field is re-described despite an output schema existing. The verbose return-field enumeration adds length without adding information.

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?

Given a nested-looking filter schema and a rich output schema, the description supplies everything an agent needs: required root param, defaults, enum pairing rules, filter composition semantics, and the multi-result caution. Nothing material to correct invocation is missing.

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

Parameters5/5

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

At 50% schema coverage the description must compensate, and it does: it specifies page is 0-based (default 0), page_size default 20/max 100, and fully maps the valid field→operator pairs for filter_groups. It also warns that field/operator are enums requiring exact strings, which the schema alone does not emphasize.

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?

The description opens with a specific verb+resource ('Search and filter workspaces for a user') and scopes it to the current user's memberships. It is readily distinguishable from siblings like search_workspace_members, get_current_workspace, and find_companies.

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

Usage Guidelines5/5

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

A numbered decision guide enumerates eight concrete scenarios (list-all, substring, regex, UUID lookup, bulk IN, domain, type, date range) each with the exact enum pair to use. This is explicit when-to-use guidance that leaves nothing 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.

Resources