Sauce Labs MCP Server

Official

Overview Schema Source Related Servers Discussions Admin

lookup_users

Query organization users and return matching counts plus basic profiles and user IDs for follow-up API calls. Filter by ID, username, team, role, name/email phrase, status, limit, or offset.

Instructions

    Queries the organization of the requesting account and returns the number of users matching the query and a basic
    profile of each user, including the ID value, which may be a required parameter of other API calls related to a
    specific user. You can narrow the results of your query using any of the following filtering parameters.
    :param id: Optional. Comma-separated user IDs. Allows to receive details of multiple user at once. For example,
        id=3d60780314724ab8ac688b50aadd9ff9,f9acc7c5b1da4fd0902b184c4f0b6324 would return details of users with IDs
        included in the provided list.
    :param username: Optional. Limits the results to usernames that begin with the specified value. For example,
        username=an would return all users in the organization with usernames beginning with "an".
    :param teams: Optional. Limit results to users who belong to the specified team_ids. Specify multiple teams as
        comma-separated values.
    :param roles: Optional. Limit results to users who are assigned certain roles. Valid values are: 1 - Organization Admin,
        4 - Team Admin, 3 - Member. Specify multiple roles as comma-separated values.
    :param phrase: Optional. Limit results to users whose first name, last name, or email address begins with the specified value.
    :param status: Optional. Limit results to users of the specifid status. Valid values are: 'active', 'pending', 'inactive'
    :param limit: Optional. Limit results to a maximum number per page. Default value is 20.
    :param offset: Optional. The starting record number from which to return results.

Input Schema

Name	Required	Description	Default
`id`	No
`limit`	No
`roles`	No
`teams`	No
`offset`	No
`phrase`	No
`status`	No
`username`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed8 schema fields changedv1.3.0Oct 25, 2026

addedOutput schema / $defs / ErrorResponse

Added value: +{
+  "properties": {
+    "error": {
+      "title": "Error",
+      "type": "string"
+    }
+  },
+  "required": [
+    "error"
+  ],
+  "title": "ErrorResponse",
+  "type": "object"
+}

addedOutput schema / $defs / LookupUsers

Added value: +{
+  "properties": {
+    "count": {
+      "title": "Count",
+      "type": "integer"
+    },
+    "links": {
+      "$ref": "#/$defs/LookupUsersLinks"
+    },
+    "results": {
+      "items": {
+        "$ref": "#/$defs/ResultItem"
+      },
+      "title": "Results",
+      "type": "array"
+    }
+  },
+  "required": [
+    "links",
+    "count",
+    "results"
+  ],
+  "title": "LookupUsers",
+  "type": "object"
+}

removedOutput schema / properties / count

Removed value: -{
-  "title": "Count",
-  "type": "integer"
-}

removedOutput schema / properties / links

Removed value: -{
-  "$ref": "#/$defs/LookupUsersLinks"
-}

addedOutput schema / properties / result

Added value: +{
+  "anyOf": [
+    {
+      "$ref": "#/$defs/LookupUsers"
+    },
+    {
+      "$ref": "#/$defs/ErrorResponse"
+    }
+  ],
+  "title": "Result"
+}

removedOutput schema / properties / results

Removed value: -{
-  "items": {
-    "$ref": "#/$defs/ResultItem"
-  },
-  "title": "Results",
-  "type": "array"
-}

changedOutput schema / required

Previous value: -[
-  "links",
-  "count",
-  "results"
-]New value: +[
+  "result"
+]

changedOutput schema / title

Previous value: -"LookupUsers"New value: +"lookup_usersOutput"

First observedJan 23, 2026

TDQS

A3.8/5.0

Behavior3/5

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

No annotations are provided, so the description carries the full load; it establishes this as a read-only lookup and discloses pagination behavior (limit defaults to 20, offset is a starting record). It does not cover permission requirements, whether results are scoped to the caller's org only in practice, or rate/response-size behavior, so gaps remain for an unannotated tool.

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

Conciseness4/5

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

Purpose is front-loaded and each parameter note earns its place, though the repeated 'Optional.' preamble and Sphinx :param: formatting add boilerplate. Content-to-length ratio is good for an 8-parameter tool.

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?

With an output schema present, return values need not be detailed, and all parameters are covered with semantics and defaults. The main residual gap is selection guidance relative to sibling lookup tools, which matters in a family containing get_user, list_team_members, and lookup_teams.

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?

Schema description coverage is 0%, and the description compensates fully: all 8 parameters are documented with concrete examples (comma-separated IDs, prefix matching on username and phrase, comma-separated teams) and enumerated valid values for roles (1/3/4) and status (active/pending/inactive). This is meaning the schema alone cannot supply.

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?

States a specific verb+resource ('Queries the organization ... returns the number of users matching the query and a basic profile of each user') and even explains the ID's downstream usefulness. It implicitly separates itself from get_user and list_team_members by being a filtered multi-user search, but never names a sibling explicitly.

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 explains how to narrow a query via filters, but gives no when-to-use guidance against get_user, list_team_members, or lookup_teams, and no exclusions or prerequisites. Usage is implied rather than directed.

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