Sauce MCP Tools
Beta
Sauce MCP is currently in beta. The available tools may change.
Sauce MCP exposes Sauce Labs capabilities as MCP tools, grouped by capability area below. Each group lists its tools, what they do, an example prompt, and availability. You rarely name a tool yourself: you describe a goal in plain language, and your AI client decides which tools to call. For more prompts, see the Prompting Guide.
Requirements
important
Some tools need entitlements beyond a standard Sauce Labs account:
- Private Device and Real Device Access API tools (creating sessions, taking screenshots, tapping, installing apps, running shell commands, capturing network traffic, and working with device files) need private (dedicated) devices and Real Device Access API concurrency.
- Test Authoring tools (generating, managing, running, and scheduling test cases and suites) need Sauce AI for Test Authoring, a paid add-on for Enterprise accounts. See Sauce AI for Test Authoring.
Beyond these entitlements, access to specific tools and capabilities can also depend on your role and permissions within your Sauce Labs organization. If a tool is missing or returns a permissions error, ask your organization administrator to review your team membership and access settings.
Account & team
Look up account, user, team, and region information. Useful for confirming which environment your agent is working in.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
get_account_info | Retrieve your Sauce Labs account details and concurrency limits. | "What are my account's concurrency limits?" | Standard |
get_user | Look up details for a specific user. | "Show the details for user jdoe." | Standard |
get_my_active_team | Show the team your account is currently acting under. | "Which team am I currently using?" | Standard |
lookup_teams | Search the teams in your organization. | "List the teams in my organization." | Standard |
get_active_region | Report which Sauce Labs data center the server is connected to. | "Which Sauce Labs region am I connected to?" | Standard |
Real Device Access API
Device discovery
List devices in the Sauce Labs catalog and check their live availability before provisioning a session.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
listDevices | List real devices in the catalog, with optional filters for OS, version, and form factor. | "What Android 14 phones are available?" | Private Device and Real Device Access API |
listDeviceStatus | Show the live status (available, in use, cleaning, offline) of devices. | "Is a Galaxy S24 free right now?" | Private Device and Real Device Access API |
get_specific_device | Retrieve the full descriptor for a single device. | "Show details for the iPhone 15 Pro." | Private Device and Real Device Access API |
Real device sessions
Start, inspect, and end real-device sessions, and interact with the device directly.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
createSession | Start a real-device session on a chosen device and return a session you reference in later calls. | "Start a session on an available Pixel 8." | Private Device and Real Device Access API |
listSessions | List your active real-device sessions. | "What sessions do I have open?" | Private Device and Real Device Access API |
deleteSession | End an active session and release the device. | "Close my current session." | Private Device and Real Device Access API |
take_screenshot | Capture a PNG screenshot of the current device screen. | "Take a screenshot of the current screen." | Private Device and Real Device Access API |
tap_element | Tap an element or screen coordinates on the device. | "Tap the Login button." | Private Device and Real Device Access API |
dump_ui | Return the device's current UI hierarchy for inspection. | "What elements are on the screen right now?" | Private Device and Real Device Access API |
openUrl | Open a URL on the device. | "Open example.com on the device." | Private Device and Real Device Access API |
applyDeviceSettings | Change device settings such as orientation, locale, or animations. | "Switch the device to dark mode." | Private Device and Real Device Access API |
executeShellCommand | Run an ADB shell command on an Android device. | "Run pm list packages on the device." | Private Device and Real Device Access API |
App management
Install, launch, and uninstall apps from Sauce Storage on a device, and check installation status.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
installApp | Install an app from Sauce Storage onto the device. | "Install the latest build from Sauce Storage." | Private Device and Real Device Access API |
launchApp | Launch an installed app on the device. | "Launch the app." | Private Device and Real Device Access API |
uninstallApp | Remove an installed app from the device. | "Uninstall the app from the device." | Private Device and Real Device Access API |
listAppInstallations | List apps currently installed in the session. | "What apps are installed in this session?" | Private Device and Real Device Access API |
waitForAppInstallation | Wait until an app finishes installing. | "Wait until the app finishes installing." | Private Device and Real Device Access API |
Device files
Browse and manage files on the device filesystem during a session.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
listFiles | List files in a directory on the device. | "List the files under /sdcard/Download." | Private Device and Real Device Access API |
statFile | Get metadata for a file on the device. | "Show the metadata for that file." | Private Device and Real Device Access API |
removeFile | Delete a file on the device. | "Delete /sdcard/Download/report.csv." | Private Device and Real Device Access API |
Network
Shape network conditions and capture traffic during a session.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
setNetworkConditions | Apply custom network conditions (latency, bandwidth, packet loss) to the device. | "Throttle the connection to 3G speeds." | Private Device and Real Device Access API |
setNetworkProfile | Apply a predefined network profile to the device. | "Apply the 4G network profile." | Private Device and Real Device Access API |
listNetworkProfiles | List the available network profiles. | "What network profiles are available?" | Private Device and Real Device Access API |
startNetworkCapture | Begin capturing the device's network traffic. | "Start capturing network traffic." | Private Device and Real Device Access API |
stopNetworkCapture | Stop the active network capture. | "Stop the network capture." | Private Device and Real Device Access API |
Jobs, builds & assets
Inspect jobs and builds, and retrieve the assets they produce, such as logs, screenshots, video, and network captures.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
get_recent_jobs | List your most recent jobs. | "Show my most recent jobs." | Real Device Cloud or Virtual Device Cloud |
get_job_details | Retrieve the details and result of a specific job. | "Why did my last job fail?" | Real Device Cloud or Virtual Device Cloud |
get_real_device_jobs | List real-device jobs. | "List my real-device jobs." | Real Device Cloud or Virtual Device Cloud |
get_specific_real_device_job | Retrieve the details of a specific real-device job. | "Show the details of job 1a2b3c." | Real Device Cloud or Virtual Device Cloud |
get_test_assets | List the assets attached to a job. | "What assets does that job have?" | Real Device Cloud or Virtual Device Cloud |
get_artifact_file | Retrieve a specific artifact file from a job. | "Download the logcat from that job." | Real Device Cloud or Virtual Device Cloud |
get_network_har_file | Retrieve a job's captured network traffic as a HAR file. | "Get the HAR file from that job." | Real Device Cloud or Virtual Device Cloud |
filter_har_data | Filter a HAR capture down to the entries you care about. | "Show only the failed requests in that HAR." | Real Device Cloud or Virtual Device Cloud |
lookup_builds | Search your builds. | "List my recent builds." | Real Device Cloud or Virtual Device Cloud |
get_build | Retrieve the details of a specific build. | "Show the details of my latest build." | Real Device Cloud or Virtual Device Cloud |
Storage
Upload and browse app builds in Sauce Storage.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
upload_file_to_storage | Upload an app build to Sauce Storage. | "Upload this APK to Sauce Storage." | Real Device Cloud or Virtual Device Cloud |
get_storage_files | List the app builds in Sauce Storage. | "What app builds are in my storage?" | Real Device Cloud or Virtual Device Cloud |
get_storage_groups | List the storage groups (apps grouped by identifier). | "List my storage groups." | Real Device Cloud or Virtual Device Cloud |
Tunnels
Inspect Sauce Connect tunnels and the jobs running through them.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
get_tunnel_information | Retrieve details for a specific tunnel. | "Show details for tunnel my-tunnel." | Standard |
get_tunnels_for_user | List the tunnels owned by a user. | "Do I have any active tunnels?" | Standard |
get_current_jobs_for_tunnel | List the jobs currently running through a tunnel. | "What jobs are running through my tunnel?" | Standard |
Test Authoring
The following tools are powered by Sauce AI for Test Authoring, a paid add-on for Enterprise accounts. They let your agent generate test cases from natural-language intent, manage and run them, organize them into suites, and schedule recurring runs — all without writing code. All tools in this section require the Test Authoring add-on.
Test cases
Generate test cases from natural-language intent and manage your saved test cases. You describe what to test, and a test case is generated, saved, and made runnable.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
generate_test_case | Generate a test case from a natural-language intent against a web URL or a mobile app in Sauce Storage. | "Generate a test case using the latest Chrome version on Linux that logs into saucedemo.com and adds an item to the cart." | Test Authoring |
Get_test_case_generation_status | Check the status of an asynchronous generation task and get the resulting test case ID when it completes. | "Is my test case done generating yet?" | Test Authoring |
List_test_cases | List and search your saved test cases, with filters for search term, date range, user, team, and suite. | "List my test cases that mention checkout." | Test Authoring |
Get_a_test_case | Retrieve the full details and steps of a single test case. | "Show me the steps in the login test case." | Test Authoring |
Rename_a_test_case | Rename an existing test case. | "Rename that test case to 'Checkout - happy path'." | Test Authoring |
Delete_a_test_case | Delete a test case. | "Delete the old smoke-test test case." | Test Authoring |
Code generation
Export an authored test case as runnable source code in the language and framework of your choice.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
List_valid_code_generation_targets_for_a_test_case | List the language/framework targets available for a given test case (depends on its platform). | "What languages can I export this test case to?" | Test Authoring |
Generate_source_code_for_a_test_case | Generate source code for the latest revision of a test case in a chosen target (e.g. javascript_webdriverio). | "Give me this test case as Python Selenium code." | Test Authoring |
Running test cases
Run authored test cases on Sauce Labs and inspect the results.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
Run_a_test_case | Start a run of a test case against one or more browser/device targets, optionally under a build name and Sauce Connect tunnel. | "Run the login test case on Chrome and Safari." | Test Authoring |
Get_a_test_case_run | Retrieve the status and result of a specific test case run. | "Did my last test case run pass?" | Test Authoring |
List_test_case_runs | List the runs for a test case. | "Show the run history for this test case." | Test Authoring |
Get_artifact_file | Retrieve an artifact file (such as a screenshot or log) produced by a test case run. | "Download the screenshot from that run." | Test Authoring |
Test suites
Group test cases into suites and run them together for broader regression coverage.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
Create_a_test_suite | Create a test suite, optionally with a name, tags, and an initial set of test cases. | "Create a 'Checkout regression' suite from these three test cases." | Test Authoring |
List_test_suites | List your test suites. | "What test suites do I have?" | Test Authoring |
Get_a_test_suite | Retrieve the details of a single test suite, including its test cases. | "What's in the checkout regression suite?" | Test Authoring |
Update_a_test_suite | Update a suite — rename it, change tags, or add and remove test cases. | "Add the guest-checkout test to the regression suite." | Test Authoring |
Delete_a_test_suite | Delete a test suite. | "Delete the old regression suite." | Test Authoring |
Run_all_test_cases_in_a_suite | Queue runs for every test case in a suite, optionally under a shared build name. | "Run all tests in the checkout regression suite." | Test Authoring |
Test schedules
Schedule test suites to run automatically on a recurring cadence.
| Tool | Description | Example prompt | Requirements |
|---|---|---|---|
Create_a_test_schedule | Create a schedule that runs one or more suites on a cron cadence in a given timezone, with optional start/end dates and a max run count. | "Schedule the regression suite to run every weekday at 6am Eastern." | Test Authoring |
List_test_schedules | List your test schedules. | "What schedules do I have set up?" | Test Authoring |
Get_a_test_schedule | Retrieve the details of a single schedule. | "Show the settings for my nightly schedule." | Test Authoring |
Update_a_test_schedule | Update a schedule — change its cadence, suites, run owner, or enable/pause it. | "Pause the nightly schedule." | Test Authoring |
Delete_a_test_schedule | Delete a schedule. | "Delete the nightly schedule." | Test Authoring |