Tools
The connector has 149 tools: 73 read tools and 76 write tools, 19 of which are destructive (they delete, stop, or end something). The assistant picks the tools on its own based on your request: you don't need to know their names. This list shows what you can ask for and which profile permission each thing requires.
- Read works with a read-only connection. Write requires a read-and-write connection and write access enabled in the organization. See Permissions and security.
- Destructive: deletes, stops, or ends something; the assistant confirms with you before calling it.
- Profile permission: the permission your profile needs in the organization, as on the Profiles screen. On top of it, the automation's team rule applies.
Automations and components
Automations, folders, tags, systems, components, and parameters: what the Automations and Settings screens do.
| Tool | What it does |
|---|---|
list_automations | Lists the automations you can see, with filters by name, folder, tag, component, and mobile Read · permission automation.automation.read |
get_automation | Details of an automation and its datasets, with the last run Read · permission automation.automation.read |
create_automation | Creates an automation Write · permission automation.automation.create |
update_automation | Changes the name, identifier, description, folder, tags, business process, and the teams of a private automation Write · permission automation.automation.update |
delete_automation | Deletes the automation with all its datasets and run history Write, destructive · permission automation.automation.delete |
list_automation_folders | Lists the automation folders Read · permission automation.automation.read |
create_automation_folder | Creates a folder, inside another one if you want Write · permission automation.automation.update |
list_tags | Lists the tags, with how many automations and datasets use each one Read · permission automation.tag.read |
create_tag | Creates a tag Write · permission automation.tag.create |
list_systems | Lists the systems and the git repository linked to each one Read · permission config.system.read |
create_system | Creates a system, linked to a repository or not Write · permission config.system.create |
create_git_repository | Registers the git repository with a system's code Write · permission config.gitRepository.create |
list_components | Lists the components with their documentation and system; with undocumented, only the ones without documentationRead · permission automation.component.read |
get_component | Details of a component, with its input and output parameters Read · permission automation.component.read |
create_component | Creates a component in a system, with its parameters Write · permission automation.component.create |
update_component | Changes a component's name, system, documentation, and parameters Write · permission automation.component.update |
list_parameters | Lists the organization's parameters Read · permission automation.parameter.read |
create_parameters | Creates parameters (in_ or out_); any that already exist with the same name are reusedWrite · permission automation.parameter.create |
get_parameter_usage | Where a parameter is used: components, datasets, automations, and last run Read · permission automation.parameter.read |
update_parameter | Renames a parameter or changes its description, and reminds you to change the name in the code Write · permission automation.parameter.update |
add_components_to_dataset | Adds components as steps of a dataset, in the given order Write · permission automation.datasetComponent.create |
remove_component_from_dataset | Removes a step from a dataset Write, destructive · permission automation.datasetComponent.delete |
Datasets
Datasets (the versions of an automation), parameter values, dataset variables, and general parameters.
| Tool | What it does |
|---|---|
list_datasets | Lists an automation's datasets Read · permission automation.dataset.read |
get_dataset | Details of a dataset: the steps in order, each value, and the variables Read · permission automation.dataset.read |
get_dataset_grid | All of an automation's datasets side by side, like the list on the screen Read · permission automation.dataset.read |
create_dataset | Creates a dataset as a copy of another one (with steps, values, and variables) or blank Write · permission automation.dataset.create |
update_dataset | Changes a dataset's description, tags, and default environment Write · permission automation.dataset.update |
delete_datasets | Deletes datasets, with their steps, values, and run history Write, destructive · permission automation.dataset.delete |
add_dataset_parameters | Adds parameters to a step of a dataset Write · permission automation.datasetParameter.create |
set_dataset_parameter_value | Saves the value of a dataset parameter Write · permission automation.datasetParameter.update |
list_parameter_value_options | What the value can reference: a previous step's output, a variable, a general parameter, or another dataset's output Read · permission automation.datasetParameter.read |
set_step_expected_result | Saves the expected result of a step in this dataset Write · permission automation.datasetComponent.update |
remove_dataset_parameter | Removes a parameter (and its value) from a step Write, destructive · permission automation.datasetParameter.delete |
preview_dataset_changes | Shows what a batch change of values would change, without saving anything Read · permission automation.dataset.update |
apply_dataset_changes | Saves the batch change in a single transaction: if there's any error, nothing is saved Write · permission automation.dataset.update |
list_dataset_variables | Lists a dataset's variables Read · permission automation.datasetVariable.read |
create_dataset_variable | Creates a variable in the dataset Write · permission automation.datasetVariable.create |
update_dataset_variable | Changes the name or value of a dataset variable Write · permission automation.datasetVariable.update |
list_general_parameters | Lists the general parameters, shared by all automations Read · permission automation.generalParameter.read |
create_general_parameter | Creates a general parameter Write · permission automation.generalParameter.create |
update_general_parameter | Changes a general parameter Write · permission automation.generalParameter.update |
Environments
Run environments (Staging, Production) and their variables. Secret variables can be sent through the connector, but their values never come back.
| Tool | What it does |
|---|---|
list_environments | Lists the environments with their variables and how many datasets use each one; secrets come back as ***Read · permission automation.environment.read |
create_environment | Creates an environment, also as a copy of another one Write · permission automation.environment.create |
update_environment | Renames the environment, changes its description, or marks it as production Write · permission automation.environment.update |
delete_environment | Deletes the environment and its variables Write, destructive · permission automation.environment.delete |
set_environment_variable | Creates or changes a variable by name, including secrets Write · permission automation.environment.update |
delete_environment_variable | Deletes an environment variable Write, destructive · permission automation.environment.update |
set_datasets_environment | Sets the default environment of several datasets at once Write · permission automation.dataset.update |
Runners, groups, and runs
Runners, automation groups, cycles, starting runs, recurring runs, and run tracking, as in the Automation Center.
Runners and clusters
| Tool | What it does |
|---|---|
list_runners | Lists the runners you can use, with status, CPU, and memory; with onlyAvailable, only the active ones that aren't OfflineRead · permission infrastructure.runner.read |
list_clusters | Lists the clusters and the runners in each one Read · permission infrastructure.cluster.read |
list_cloud_runners | Lists the cloud runners that are on and the available machines, with the hourly price Read · permission infrastructure.cloudRunner.read |
start_cloud_runner | Turns on a cloud runner: a machine in the cloud, paid by the hour until it's turned off Write · permission infrastructure.cloudRunner.create |
stop_cloud_runner | Turns off a cloud runner and ends the billing Write, destructive · permission infrastructure.cloudRunner.delete |
Groups and cycles
| Tool | What it does |
|---|---|
list_automation_groups | Lists the automation groups, with their purpose (testing or operation) Read · permission automation.automationGroup.read |
get_automation_group | A group with its cycles and the datasets of a cycle, with the status of each one Read · permission automation.automationGroup.read |
create_automation_group | Creates a group with its first cycle and, if you want, the datasets or the automations Write · permission automation.automationGroup.create |
add_datasets_to_group | Adds datasets (or the most recent dataset of automations) to a group Write · permission automation.automationGroup.create |
remove_dataset_from_group | Removes a dataset from the group; past runs are kept Write, destructive · permission automation.automationGroup.delete |
list_cycles | Lists a group's cycles Read · permission automation.cycle.read |
create_cycle | Creates an empty cycle or one with the datasets of another cycle Write · permission automation.cycle.create |
set_cycle_open | Closes or reopens a cycle Write · permission automation.cycle.update |
Starting runs and recurring runs
| Tool | What it does |
|---|---|
run_datasets | Runs datasets of a cycle on a runner or cluster, now or scheduled, with the environment and the working branch Write · permission automation.automationCenter.run |
list_scheduled_runs | Lists a cycle's scheduled batches and, for 7 days, the ones that didn't run, with the reason Read · permission automation.automationCenter.read |
list_recurring_runs | Lists the recurring runs, with the frequency, the runner, the next run, and the reason for a pause Read · permission automation.automationCenter.read |
create_recurring_run | Creates a recurring run: every N minutes or hours, daily, weekly, or monthly Write · permission automation.automationCenter.run |
update_recurring_run | Pauses, resumes, renames, or changes the frequency, runner, environment, and branches of a recurring run Write · permission automation.automationCenter.run |
delete_recurring_run | Deletes a recurring run and cancels its batches that haven't started yet Write, destructive · permission automation.automationCenter.run |
stop_run | Stops a run that is submitted, waiting, or running Write, destructive · permission automation.automationCenter.run |
stop_cycle_runs | Stops a cycle's in-progress runs Write, destructive · permission automation.automationCenter.run |
Tracking
| Tool | What it does |
|---|---|
get_run_status | Status of the runs in a batch or of selected runs Read · permission automation.datasetRun.read |
list_dataset_runs | Run history of a dataset Read · permission automation.datasetRun.read |
get_run | Details of a run: status, end reason, start, end, duration, who stopped it, Correlation ID, and the commit of each repository; also finds the run by Correlation ID Read · permission automation.datasetRun.read |
get_run_log | Log, error message, and the AI failure diagnosis; filters by level and by text Read · permission automation.datasetRun.read |
search_run_logs | Searches the logs of many runs by text and level, over a period of up to 31 days Read · permission automation.datasetRun.read |
get_run_evidence | Evidence from a run: screenshots of each step, videos, and attachments Read · permission automation.datasetRun.read |
Schedule
Everything scheduled to run in the organization, with times in your time zone.
| Tool | What it does |
|---|---|
get_agenda | What runs in a period (scheduled batches and recurring runs) and what has already run, with the result; up to 62 days Read · permission automation.automationCenter.read |
cancel_scheduled_run | Cancels a scheduled batch that hasn't run yet; it stays in the schedule as canceled Write, destructive · permission automation.automationCenter.run |
delete_scheduled_run | Deletes a scheduled batch that hasn't run yet; it's removed from the schedule Write, destructive · permission automation.automationCenter.run |
reschedule_run | Changes the time of a scheduled batch, or runs it now Write · permission automation.automationCenter.run |
run_recurring_now | Runs a recurring run now, once, without changing its rule Write · permission automation.automationCenter.run |
skip_recurring_occurrence | Skips a future occurrence of a recurring run, or undoes the skip Write · permission automation.automationCenter.run |
Reports and analytics
The numbers for runs and automation assets, as shown on the Dashboard and the AI analyses page.
| Tool | What it does |
|---|---|
get_execution_overview | Overview of a period: total, passed, failed, pass rate, daily trend, and what's running now Read · permission automation.datasetRun.read |
get_top_failures | Datasets that failed the most in a period Read · permission automation.datasetRun.read |
get_most_executed | Datasets that ran the most in a period Read · permission automation.datasetRun.read |
get_recent_runs | Most recent runs Read · permission automation.datasetRun.read |
get_period_numbers | One period's numbers against another's: pass rate, valid runs, failures, and average duration Read · permission automation.datasetRun.read |
get_cycle_summary | How many datasets in a cycle are in each status Read · permission automation.datasetRun.read |
get_execution_insights | Run reports, broken down by process, responsible area, and owner Read · permission automation.datasetRun.read |
get_asset_insights | Health of the automation, dataset, and component assets, including undocumented ones Read · permission automation.automation.read |
Processes, documentation, and traceability
Business processes, the organization's people and areas, the BPMN diagram, the automation document, the traceability matrix, impact analysis, and change history.
| Tool | What it does |
|---|---|
list_processes | Lists the business processes as a tree, with criticality, owner, and responsible area Read · permission organization.process.read |
get_process | Details of a process, with subprocesses, people, areas, and automations Read · permission organization.process.read |
create_process | Creates a business process Write · permission organization.process.create |
update_process | Changes a business process Write · permission organization.process.update |
delete_process | Deletes a business process Write, destructive · permission organization.process.delete |
list_people | Lists the people in processes (owners and other people involved, with no Proton sign-in) Read · permission organization.person.read |
create_person | Registers a process person Write · permission organization.person.create |
update_person | Changes a process person Write · permission organization.person.update |
delete_person | Deletes a process person Write, destructive · permission organization.person.delete |
list_business_areas | Lists the business areas, with how many people and processes each one has Read · permission organization.businessArea.read |
create_business_area | Creates a business area Write · permission organization.businessArea.create |
update_business_area | Renames an area or changes its description Write · permission organization.businessArea.update |
delete_business_area | Deletes a business area Write, destructive · permission organization.businessArea.delete |
get_traceability_matrix | Traceability matrix: process, automation, dataset, and last run, with coverage and documentation Read · permission organization.process.read |
get_component_impact | What a change to the component affects: datasets, automations, processes, and groups Read · permission automation.component.read |
get_system_impact | What a change to the system affects (new screen, version, environment) Read · permission config.system.read |
get_audit_trail | Change history of a process, person, area, component, or automation: who, when, and from which value to which Read · permission automation.automation.read |
get_automation_document | The automation document, with the process, the documented steps, the data used, and the expected result Read · permission automation.automation.read |
get_process_diagram | A process's BPMN diagram, with the tasks and the components of each one Read · permission organization.process.read |
import_process_diagram | Imports a new version of the BPMN diagram (BPMN 2.0 XML) Write · permission organization.process.update |
link_process_task | Links components to a task in the diagram Write · permission organization.process.update |
remove_process_diagram | Removes a process's BPMN diagram, with all its versions Write, destructive · permission organization.process.update |
Jira: requirements and bugs
With the Jira Cloud integration registered in Proton.
| Tool | What it does |
|---|---|
list_jira_integrations | Lists the Jira Cloud integrations Read · permission automation.requirement.read |
search_jira_issues | Searches Jira issues by key or by text in the summary Read · permission automation.requirement.read |
list_requirements | Requirements (Jira issues) covered by an automation or dataset Read · permission automation.requirement.read |
link_requirement | Links a Jira issue as a requirement of an automation or a dataset Write · permission automation.requirement.update |
unlink_requirement | Removes a requirement link Write, destructive · permission automation.requirement.update |
list_defects | Jira bugs linked to a run or a dataset Read · permission automation.defect.read |
get_defect_draft | What Proton knows about a run to open a bug: the failed step, error, log, and AI analysis Read · permission automation.defect.create |
create_defect | Opens a Jira bug from a run, with the PDF report and a link back Write · permission automation.defect.create |
link_defect | Links an existing bug to a run Write · permission automation.defect.create |
Xray and Zephyr
Test management in Jira, with the Xray Cloud or Zephyr integration registered in Proton.
| Tool | What it does |
|---|---|
list_xray_integrations | Lists the Xray Cloud and Zephyr integrations Read · permission automation.automationGroup.read |
get_group_test_management | Where a group publishes its results: project, Test Plan, and what Proton creates Read · permission automation.automationGroup.read |
set_group_test_management | Makes the group publish each batch to a Test Execution, linked to the Test Plan Write · permission automation.automationGroup.update |
remove_group_test_management | The group stops publishing its results Write, destructive · permission automation.automationGroup.update |
publish_batch_to_xray | Publishes a batch again now Write · permission automation.automationGroup.update |
link_dataset_to_xray_test | Points a dataset to an existing Test Write · permission automation.dataset.update |
search_xray_test_plans | Searches Test Plans by key or by a word in the summary Read · permission automation.automationGroup.create |
preview_xray_plan_import | Shows what importing a Test Plan would do, without changing anything Read · permission automation.automationGroup.create |
import_xray_plan | Imports a Test Plan as an automation group, or syncs the group that already came from it Write · permission automation.automationGroup.create |
get_automation_xray_tests | The Test of each dataset of an automation Read · permission automation.dataset.read |
get_run_xray_links | Where a run is in Xray: Test Execution, Test, and Test Plan, with the links Read · permission automation.datasetRun.read |
create_xray_tests | Creates a manual Test, with its steps, for each dataset that doesn't have one yet Write · permission automation.dataset.update |
list_xray_folders | Folders in the Test repository of a Jira project Read · permission automation.dataset.read |
run_xray_issue | Runs from an Xray issue (Test Plan or Test Execution), like the Jira Automation rule Write · permission automation.automationCenter.run |
Robot operations
The exception queue of Operation groups. Only with the RPA module enabled in the organization.
| Tool | What it does |
|---|---|
list_run_exceptions | Lists the exception queue: robots that failed, didn't run, or got stuck Read · permission operation.exception.read |
get_run_exception | An exception with its timeline Read · permission operation.exception.read |
update_run_exception | Assigns an exception, changes its status with a note, or comments on it Write · permission operation.exception.update |
rerun_run_exception | Reruns now; if it passes, the exception is resolved Write · permission operation.exception.update |
Git repositories
The git work that used to be done only on the screens. The connector only reads your git, through the integration registered in Proton: no tool writes to the repository.
| Tool | What it does |
|---|---|
list_git_integrations | Lists the git integrations (GitHub, GitLab, Bitbucket), without the credential Read · permission config.integration.read |
list_repository_branches | Lists a repository's branches, read from the provider Read · permission config.system.read |
update_git_repository | Changes the default branch, the description, or the integration of a registered repository Write · permission config.gitRepository.update |
update_system | Renames a system or links it to another registered repository Write · permission config.system.update |
Project from scratch and checks
Start an automation project with AI and check the code and the Proton setup before running. See Project from scratch.
| Tool | What it does |
|---|---|
get_project_template | The language's public template (Python or Java) to clone, with the project rules Read · no profile permission |
generate_component_code | The component file in the template's format, with each parameter read by name Read · permission automation.component.read |
check_project | Checks the repository code against the project contract and the registered components, read-only Read · permission config.gitRepository.read |
check_automation | Checks whether the datasets are ready to run: steps, values, references, secrets, environment, runner, and cycle Read · permission automation.dataset.read |
People
| Tool | What it does |
|---|---|
list_users | The organization's users, with profile, license, and teams Read · permission identity.user.read |
Proton documentation
| Tool | What it does |
|---|---|
search_proton_documentation | Searches this documentation Read · no profile permission |
get_documentation_recommendations | Articles from this documentation related to a topic Read · no profile permission |