Skip to content

MCP server - tools

Complete list of every tool the server can register, grouped by category:

  • Read tools - Retrieve information about your Active Everywhere deployment.
  • Analytics and security tools - Retrieve analytics and security information (available in Active Everywhere 6.0 and newer).
  • Write tools - Manage your Active Everywhere deployment: create Jobs and Job runs, modify Agents, update Management Console settings, and more.

Read tools

Agents

Tool Description
GetAgents List and filter Agents.
GetAgentById Get Agent details by ID.
GetAgentCustomJobsPriority Get custom job priority settings for an Agent.
GetAgentEntriesByPath Browse Agent filesystem or cloud storage.
GetAgentJobRun Get run status for a specific Agent in a run.
GetAgentJobRuns List job runs for an Agent.
GetAgentJobs Get jobs assigned to an Agent.

Diagnostics

Tool Description
DiagnoseFailingRuns Find runs that aborted, timed out, or had errors.
DiagnoseOfflineAgents Find offline/error/warning Agents.
GetJobHealthOverview Health dashboard for all jobs.
DiagnoseStalledTransfers Find stalled Agents in active runs.
InvestigateRunErrors Deep-dive into a specific run's errors.
InvestigateAgentHealth Deep-dive into a specific Agent's health.
StartCloudConnectionTest Test cloud storage connectivity on an Agent.
GetActiveDiagnosticTest Check if a diagnostic test is running.
StopDiagnosticTest Stop a running diagnostic test.

Documentation

Tool Description
SearchDocumentation Search Resilio docs by keyword.
FetchDocumentationPage Read a documentation page.

File queries

Tool Description
GetFileQueryById Get file query status by ID.
GetFileQueryByJobRunId Get file query status for a job run.

Groups

Tool Description
GetAllGroups List all Agent groups.
GetGroupById Get group details by ID.

Infrastructure and settings

Tool Description
  • GetLdapSettings
  • GetAzureAdSettings
  • GetOktaSettings
  • GetOAuth2Settings
  • GetCustomOidcSettings
 Get authentication provider settings.
GetSmtpSettings Get SMTP/email settings.
  • GetAllTrackers
  • GetTrackerById
 List / get tracker servers.
  • GetAllApiTokens
  • GetApiTokenById
 List / get API tokens.
  • GetAllAbortJobRunErrors
  • GetAbortJobRunErrorByCode
 List / get auto-abort error rules.
GetBackups List Management Console configuration backups.
GetSupportRequestState Check the status of a support request.
  • GetPendingAgents
  • GetRemovedAgents
 List pending / removed Agents.

Jobs

Tool Description
GetAllJobs List all jobs with optional filters.
GetJobById Get job details by ID.
GetJobGroups Get groups associated with a job.

Notifications and webhooks

Tool Description
  • GetAllNotifications
  • GetNotificationById
 List / get notifications.
  • GetAllWebhooks
  • GetWebhookById
 List / get webhooks.

Profiles, file policies and bandwidth schedules

Tool Description
  • GetAllAgentProfiles
  • GetAgentProfileById
 List / get Agent profiles.
  • GetAllJobProfiles
  • GetJobProfileById
 List / get job profiles.
  • GetAllFilePolicies
  • GetFilePolicyById
 List / get file caching policies.
GetFilePolicyJobs List jobs using a file policy.
  • GetAllBandwidthSchedules
  • GetBandwidthScheduleById
 List / get bandwidth schedules.

Reports

Tool Description
GetReportById Get a built report by ID.
GetReportsByJobRunId Get reports for a job run.

Runs

Tool Description
GetRuns List job runs with filters.
GetRunById Get run details by ID.
GetRunAgents Get all Agents in a run.
GetRunAgent Get a specific Agent's status in a run.
GetRunAgentConnections Get Agent connection details in a run.
GetRunAgentActivity Get Agent activity in a run.
GetRunAgentActiveFiles Get files currently being transferred.
GetRunAffectedFilesByError Get files affected by a specific error.
GetRunFolderRescanDetails Get folder rescan history for an Agent.
GetRunNetworkPolicy Get network policy for a run.
GetRunFileLocks Get file locks in a run.
RevokeFileLocksByFilter Force-revoke file locks matching a filter (destructive).
RevokeFileLocksByPath Force-revoke file locks by file path (destructive).

Server and license

Tool Description
GetServerInfo Management Console version and OS.
GetLicensePackages List license packages.
GetAdvancedSettings Get advanced Management Console settings.

Storage connectors

Tool Description
GetAllStorages List cloud storage connectors.
GetStorageById Get storage connector details by ID.

Users and user groups

Tool Description
  • GetAllUsers
  • GetUserById
 List / get users.
GetUserUserGroups Get the user groups a user belongs to.
  • GetAllUserGroups
  • GetUserGroupById
 List / get user groups.
GetUserGroupMembers List members of a user group.

Analytics and security tools

Feature availability

Available in Resilio Active Everywhere 6.0 and newer.

Auto-enabled when the connected Management Console supports analytics (6.0+); override with RESILIO_ANALYTICS_ENABLED.

Tool Description
QueryAnalyticsData Run read-only SQL against the analytics database (file events, audit logs, performance stats).
GetAnalyticsSchema List the analytics tables and columns available to query.
GetReportingTimeseries Read historical timeseries from the legacy /reporting API.
GetReportingDataTypes List the timeseries data types available to GetReportingTimeseries.
ScanForSuspiciousActivity Security scan of the audit trail for suspicious activity (brute force, privilege changes, bulk deletes, etc.).

Historical data vs. current state

The analytics tools (QueryAnalyticsData, GetAnalyticsSchema) query an event-and-timeseries history and can give answers to questions such as which jobs ran last week, who created or deleted a job, how many jobs were created this month, error trends, transfer throughput — a record of what happened over time.

For questions on current state, such as how many jobs are configured, which Agents exist, what is the current job configuration, use the REST read tools (GetAllJobs, GetAgents, GetAllGroups, etc.).

Write tools

Write and mutation tools (creating jobs, modifying Agents, etc.) are disabled by default. Set RESILIO_WRITE_ENABLED=true to enable them.

Use at your own risk

Enabling write tools lets your AI tools perform tasks such as starting runs, hydrating and dehydrating files, rescanning, etc. Some of those tasks involve moving or deleting actual files on Agents. Use this feature at your own discretion and to reduce the risk of loosing data, keep the token tightly scoped.

Auto-backup

Every write tool automatically creates a Management Console configuration backup before it makes a change, and it cancels the change if that backup fails. Note that only the configuration is backed up, not the actual data stored in Job folders.

Confirmation prompts

In case of a dangerous write operations, your AI tool will list the changes, and ask for confirmation before proceeding with applying them.

Agents

Tool Description
UpdateAgent Update an Agent's name, tags, or WAN setting.
SetAgentJobsPriority Set custom job priorities on an Agent.
RescanFolder Trigger a folder rescan on an Agent.
CreateFolderOnAgent Create a folder on an Agent's filesystem/storage.

Groups, profiles, policies and schedules

Tool Description
  • CreateGroup
  • UpdateGroup
 Create / update an Agent group.
  • CreateAgentProfile
  • UpdateAgentProfile
 Create / update an Agent profile.
  • CreateJobProfile
  • UpdateJobProfile
 Create / update a job profile.
  • CreateFilePolicy
  • UpdateFilePolicy
 Create / update a file caching policy.
  • CreateBandwidthSchedule
  • UpdateBandwidthSchedule
 Create / update a bandwidth schedule.

Infrastructure

Tool Description
  • CreateTracker
  • UpdateTracker
 Create / update a tracker server.
TestTrackerConnection Test connectivity to a tracker.
CreateApiToken Create an API token.
  • AddAbortJobRunError
  • UpdateAbortJobRunError
 Create / update auto-abort error rules.
UpdateAdvancedSettings Update advanced Management Console settings.
  • ConfigureSmtp
  • SendTestEmail
 Configure SMTP / send a test email.
  • ApprovePendingAgent
  • DeclinePendingAgent
 Approve / decline a pending Agent.
CreateBackup Create a Management Console configuration backup.
CreateSupportRequest Create a support request with debug logs.

Jobs and runs

Tool Description
  • CreateJob
  • UpdateJob
 Create / update a job.
CreateRun Start a job run.
  • StopRun
  • PauseRun
  • ResumeRun
 Stop / pause / resume a run.
  • StopRunOnAgents
  • StopInitialSync
  • RestartAgentsInRun
 Stop or restart specific Agents in a run.
  • AddAgentToRun
  • AddFilesToRun
 Add an Agent or files to an active run.
  • HydrateFiles
  • DehydrateFiles
  • PinFiles
 Hydrate / dehydrate / pin cached files.

Storage, users, notifications

Tool Description
  • CreateStorage
  • UpdateStorage
 Create / update a cloud storage connector.
  • CreateUser
  • UpdateUser
 Create / update a user.
  • CreateUserGroup
  • UpdateUserGroup
 Create / update a user group.
  • CreateNotification
  • UpdateNotification
 Create / update a notification.
  • CreateWebhook
  • UpdateWebhook
 Create / update a webhook.