The MongoDB Atlas connector lets your AI agent work with MongoDB Atlas. You connect it once with a service account, and Scalekit authenticates every call, so your agent never handles credentials. It comes with 82 tools.
- Tools
- 82
- What they doRead · write · destructive
- 55 · 20 · 755 read20 write7 destructive
- Users sign in with
- Service account
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the MongoDB Atlas connection
In AgentKit > Connections, create a MongoDB Atlas connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolmongodb_access_list_entries_listList the entries in an Atlas project's IP access list, which controls which clients may connect to its clusters.Read-onlyList IP Access List Entries
List the entries in an Atlas project's IP access list, which controls which clients may connect to its clusters. Returns each entry's ipAddress or cidrBlock or awsSecurityGroup, comment, and deleteAfterDate. Use this to see which addresses can connect. Use mongodb_access_list_entry_get for one entry. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_access_list_entry_getGet one entry from an Atlas project's IP access list.Read-onlyGet IP Access List Entry
Get one entry from an Atlas project's IP access list. Returns the entry's ipAddress or cidrBlock or awsSecurityGroup, comment, and deleteAfterDate. Use this to check one address. Use mongodb_access_list_entry_status_get to see whether it is active on every cluster. Requires a project id from mongodb_projects_list.
Inputs
entry_valuestringrequired- The access list entry to act on: an IP address, a CIDR block with its slash URL-encoded as %2F, or an AWS security group id. Get it from mongodb_access_list_entries_list. Example: 192.0.2.0%2F24
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_access_list_entry_status_getCheck whether one IP access list entry is active on every cluster in the project.Read-onlyGet IP Access List Entry Status
Check whether one IP access list entry is active on every cluster in the project. Returns STATUS: ACTIVE, PENDING, or FAILED. Use this after mongodb_access_list_entry_create to confirm the entry is live. Use mongodb_access_list_entry_get for the entry itself. Requires a project id from mongodb_projects_list.
Inputs
entry_valuestringrequired- The access list entry to act on: an IP address, a CIDR block with its slash URL-encoded as %2F, or an AWS security group id. Get it from mongodb_access_list_entries_list. Example: 192.0.2.0%2F24
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_alert_config_getGet one Atlas alert configuration (alert rule).Read-onlyGet Alert Configuration
Get one Atlas alert configuration (alert rule). Returns the configuration's eventTypeName, enabled flag, matchers, threshold, and notifications. Use this to read one rule. Use mongodb_alert_configs_list to find configuration ids. Requires a project id from mongodb_projects_list and an alert configuration id from mongodb_alert_configs_list.
Inputs
alert_config_idstringrequired- Unique 24-hexadecimal id of the alert configuration. Get it from mongodb_alert_configs_list. Example: 5f4007f327a3bd7b6f4103c8
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_alert_configs_listList the alert configurations (alert rules) in one Atlas project.Read-onlyList Alert Configurations
List the alert configurations (alert rules) in one Atlas project. Returns each configuration's id, eventTypeName, enabled flag, matchers, metric threshold, and notifications. Use this to review alert rules. Use mongodb_alerts_list for alerts that have fired. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_alert_getGet one Atlas alert by id.Read-onlyGet Alert
Get one Atlas alert by id. Returns the alert's eventTypeName, status, metricName, currentValue, cluster and host, created and resolved dates, and acknowledgement fields. Use this for one alert's details. Use mongodb_alerts_list to find alert ids. Requires a project id from mongodb_projects_list and an alert id from mongodb_alerts_list.
Inputs
alert_idstringrequired- Unique 24-hexadecimal id of the alert. Get it from mongodb_alerts_list. Example: 5f4007f327a3bd7b6f4103c7
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_alerts_listList the alerts raised in one Atlas project, optionally filtered by status.Read-onlyList Alerts
List the alerts raised in one Atlas project, optionally filtered by status. Returns each alert's id, eventTypeName, status, metricName, currentValue, clusterName, hostnameAndPort, created date, and acknowledgement fields. Use this to see what is firing. Use mongodb_alert_get for one alert, or mongodb_project_events_list for the full activity feed. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
statusstring- Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. Allowed values: OPEN, TRACKING, CLOSED. Example: OPENone of
OPENTRACKINGCLOSED
mongodb_backup_restore_job_getGet one cloud backup restore job.Read-onlyGet Restore Job
Get one cloud backup restore job. Returns the job's deliveryType, snapshotId, target cluster, failed, cancelled and expired flags, finishedAt, and download URLs for download restores. Use this to poll a restore started with mongodb_backup_restore_job_create. Requires a project id and cluster name from mongodb_clusters_list and a restore job id from mongodb_backup_restore_jobs_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
restore_job_idstringrequired- Unique 24-hexadecimal id of the restore job. Get it from mongodb_backup_restore_jobs_list or mongodb_backup_restore_job_create. Example: 5f4007f327a3bd7b6f4103c6
mongodb_backup_restore_jobs_listList the cloud backup restore jobs for one cluster.Read-onlyList Restore Jobs
List the cloud backup restore jobs for one cluster. Returns each job's id, deliveryType, snapshotId, targetClusterName, failed and cancelled flags, and finishedAt. Use this to track restores. Use mongodb_backup_restore_job_get for one job. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_backup_schedule_getGet a cluster's cloud backup schedule and retention policy.Read-onlyGet Backup Schedule
Get a cluster's cloud backup schedule and retention policy. Returns the policies (frequency and retention per snapshot type), referenceHourOfDay, nextSnapshot, and restoreWindowDays. Use this to see when snapshots run and how long they are kept. Use mongodb_backup_snapshots_list for the snapshots themselves. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_backup_snapshot_getGet one cloud backup snapshot of a replica set cluster.Read-onlyGet Backup Snapshot
Get one cloud backup snapshot of a replica set cluster. Returns the snapshot's createdAt, expiresAt, status, snapshotType, mongodVersion, and storageSizeBytes. Use this to check a snapshot's status, for example after mongodb_backup_snapshot_take. Use mongodb_backup_snapshots_list to find snapshot ids. Requires a project id and cluster name from mongodb_clusters_list and a snapshot id from mongodb_backup_snapshots_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
snapshot_idstringrequired- Unique 24-hexadecimal id of the backup snapshot. Get it from mongodb_backup_snapshots_list. Example: 5f4007f327a3bd7b6f4103c5
mongodb_backup_snapshots_listList the cloud backup snapshots of one replica set cluster.Read-onlyList Backup Snapshots
List the cloud backup snapshots of one replica set cluster. Returns each snapshot's id, createdAt, expiresAt, status, snapshotType (scheduled or onDemand), frequencyType, and storageSizeBytes. Use this to pick a snapshot to restore. Use mongodb_backup_snapshot_take to create one now. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_cloud_provider_regions_listList the cloud provider regions and instance sizes available for clusters in a project.Read-onlyList Cloud Provider Regions
List the cloud provider regions and instance sizes available for clusters in a project. Returns one entry per provider with its instanceSizes and, for each size, the available regions. Use this to pick a valid provider, region and instance size before mongodb_cluster_create. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
providersarray- Cloud providers to include: AWS, GCP, or AZURE. Leave empty for all. Example: ["AWS"]
tierstring- Cluster instance size to show regions for, for example M10 or M30. Example: M10
mongodb_cluster_access_logs_listList the database authentication attempts made against a dedicated cluster, optionally filtered by result, IP address, or time range.Read-onlyList Cluster Access Logs
List the database authentication attempts made against a dedicated cluster, optionally filtered by result, IP address, or time range. Returns accessLogs entries with timestamp, username, ipAddress, authResult, authSource, hostname, and failureReason. Use this to audit who connected and investigate failed logins. Not available on M0, Flex, or shared clusters. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
auth_resultboolean- Flag that indicates whether the response returns the successful authentication attempts only. Example: false
endinteger- Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses UNIX epoch time in milliseconds. Example: 1760486400000
ip_addressstring- One Internet Protocol address that attempted to authenticate with the database. Example: 203.0.113.10
max_logsinteger- Maximum number of lines from the log to return. Atlas defaults to 20000. Example: 100
startinteger- Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses UNIX epoch time in milliseconds. Example: 1760400000000
mongodb_cluster_advanced_config_getGet the advanced configuration of a dedicated cluster, such as default read and write concerns, oplog size and retention, minimum TLS version, and JavaScript enablement.Read-onlyGet Cluster Advanced Configuration
Get the advanced configuration of a dedicated cluster, such as default read and write concerns, oplog size and retention, minimum TLS version, and JavaScript enablement. Returns the cluster's process arguments, for example defaultWriteConcern, oplogSizeMB, minimumEnabledTlsProtocol, and javascriptEnabled. Use this for mongod-level settings. Use mongodb_cluster_get for topology and hardware. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_cluster_getGet one dedicated Atlas cluster by project id and cluster name.Read-onlyGet Cluster
Get one dedicated Atlas cluster by project id and cluster name. Returns the cluster's stateName, paused flag, mongoDBVersion, replicationSpecs (provider, region, instance size, node counts), connectionStrings, and backup settings. Use this to read a cluster's full configuration or connection strings. Use mongodb_cluster_status_get to check whether changes have finished applying. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_cluster_status_getCheck whether the latest changes to an Atlas cluster have finished deploying.Read-onlyGet Cluster Change Status
Check whether the latest changes to an Atlas cluster have finished deploying. Returns changeStatus: APPLIED when all changes are live, or PENDING while Atlas is still applying them. Use this after mongodb_cluster_create or mongodb_cluster_update to wait for completion. Use mongodb_cluster_get for the full configuration. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_clusters_listList the dedicated clusters in one Atlas project.Read-onlyList Clusters
List the dedicated clusters in one Atlas project. Returns each cluster's name, stateName, clusterType, mongoDBVersion, replicationSpecs, and connectionStrings. Use this to browse one project's clusters. Use mongodb_clusters_list_all across projects, or mongodb_flex_clusters_list for Flex clusters. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
include_deleted_with_retained_backupsboolean- Flag that indicates whether to return Clusters with retain backups. Atlas defaults to false. Example: false
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_clusters_list_allList the clusters in every Atlas project the service account can access.Read-onlyList Clusters in All Projects
List the clusters in every Atlas project the service account can access. Returns one entry per project with groupId, groupName, orgId, and orgName, plus a summary of each cluster (name, type, availability, versions, node count, data size, alert count, and whether backup and auth are enabled). Use this for a cross-project overview. Use mongodb_clusters_list for full cluster details in one project.
Inputs
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_custom_role_getGet one custom database role by name.Read-onlyGet Custom Database Role
Get one custom database role by name. Returns the role's roleName, actions, and inheritedRoles. Use this to read one role's privileges. Use mongodb_custom_roles_list to find role names. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
role_namestringrequired- Name of the custom database role. Get it from mongodb_custom_roles_list. Example: reportingReader
mongodb_custom_roles_listList the custom database roles defined in one Atlas project.Read-onlyList Custom Database Roles
List the custom database roles defined in one Atlas project. Returns each role's roleName, actions (privileges and the resources they apply to), and inheritedRoles. Use this to review custom roles. Use mongodb_custom_role_get for one role. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_database_user_getGet one Atlas database user by authentication database and username.Read-onlyGet Database User
Get one Atlas database user by authentication database and username. Returns the user's username, roles, scopes, labels, and authentication type fields. Use this to check one user's roles. Use mongodb_database_users_list to browse. Requires a project id from mongodb_projects_list and a username from mongodb_database_users_list.
Inputs
database_namestringrequired- Authentication database of the user: admin for password (SCRAM) users, $external for AWS IAM, X.509, LDAP and OIDC users. Example: admin
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
usernamestringrequired- Username of the database user, exactly as Atlas stores it (for SCRAM users the plain name; for AWS IAM, X.509, LDAP or OIDC users the ARN, DN or IdP identifier). Get it from mongodb_database_users_list. Example: app-user
mongodb_database_users_listList the database users in one Atlas project.Read-onlyList Database Users
List the database users in one Atlas project. Returns each user's username, databaseName (authentication database), roles, scopes, and authentication type fields. Use this to browse users. Use mongodb_database_user_get for one user. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_drop_index_suggestions_listList the indexes Performance Advisor suggests dropping because they are unused, redundant, or hidden.Read-onlyList Indexes to Drop
List the indexes Performance Advisor suggests dropping because they are unused, redundant, or hidden. Returns content with separate unusedIndexes, redundantIndexes, and hiddenIndexes lists describing each index. Use this to reduce write overhead and storage. Use mongodb_suggested_indexes_list for indexes to add. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_flex_cluster_getGet one Atlas Flex cluster by project id and name.Read-onlyGet Flex Cluster
Get one Atlas Flex cluster by project id and name. Returns the Flex cluster's stateName, mongoDBVersion, providerSettings, connectionStrings, and backupSettings. Use this for a Flex cluster's details or connection string. Use mongodb_cluster_get for dedicated clusters. Requires a project id and Flex cluster name from mongodb_flex_clusters_list.
Inputs
cluster_namestringrequired- Human-readable label that identifies the flex cluster. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_flex_clusters_listList the Flex clusters in one Atlas project.Read-onlyList Flex Clusters
List the Flex clusters in one Atlas project. Returns each Flex cluster's name, stateName, mongoDBVersion, providerSettings, and connectionStrings. Use this for Flex clusters. Use mongodb_clusters_list for dedicated clusters. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_invoice_pending_getGet the current pending (month-to-date) invoice of an Atlas organization.Read-onlyGet Pending Invoice
Get the current pending (month-to-date) invoice of an Atlas organization. Returns the invoice's startDate, endDate, subtotalCents, and lineItems with per-SKU usage and cost. Use this for current spend. Use mongodb_invoices_list for past invoices. Requires an organization id from mongodb_organizations_list.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
mongodb_invoices_listList the invoices MongoDB issued to an Atlas organization, optionally filtered by status and date.Read-onlyList Invoices
List the invoices MongoDB issued to an Atlas organization, optionally filtered by status and date. Returns each invoice's id, startDate, endDate, statusName, amountBilledCents, and amountPaidCents. Use this for billing history. Use mongodb_invoice_pending_get for the current, still-open invoice. Requires an organization id from mongodb_organizations_list.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
from_datestring- Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate. Example: 2026-01-01
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
order_bystring- Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result. Atlas defaults to desc. Allowed values: desc, asc. Example: descone of
descasc page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
sort_bystring- Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result. Atlas defaults to END_DATE. Allowed values: START_DATE, END_DATE. Example: END_DATEone of
START_DATEEND_DATE status_namesarray- Statuses of the invoice to be retrieved. Omit to return invoices of all statuses. Allowed values: PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID, INVOICED. Example: ["PENDING", "CLOSED"]
to_datestring- Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate. Example: 2026-10-01
view_linked_invoicesboolean- Flag that indicates whether to return linked invoices in the linkedInvoices field. Atlas defaults to true. Example: true
mongodb_maintenance_window_getGet the weekly maintenance window of an Atlas project.Read-onlyGet Maintenance Window
Get the weekly maintenance window of an Atlas project. Returns dayOfWeek, hourOfDay, startASAP, numberOfDeferrals, autoDeferOnceEnabled, and protectedHours. Use this to see when Atlas may patch clusters. Use mongodb_maintenance_window_update to change it. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_online_archive_getGet one Online Archive on a cluster.Read-onlyGet Online Archive
Get one Online Archive on a cluster. Returns the archive's dbName, collName, criteria, partitionFields, state, and schedule. Use this to check one archive's state. Use mongodb_online_archives_list to find archive ids. Requires a project id and cluster name from mongodb_clusters_list and an archive id from mongodb_online_archives_list.
Inputs
archive_idstringrequired- Unique 24-hexadecimal id of the Online Archive. Get it from mongodb_online_archives_list. Example: 5f4007f327a3bd7b6f4103ca
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_online_archives_listList the Online Archives configured on a cluster, which move aged data to cheaper storage.Read-onlyList Online Archives
List the Online Archives configured on a cluster, which move aged data to cheaper storage. Returns each archive's id, dbName, collName, criteria, state, and schedule. Use this to review archiving rules. Use mongodb_online_archive_get for one archive. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_organization_events_listList the activity feed events for one Atlas organization, optionally filtered by event type or date range.Read-onlyList Organization Events
List the activity feed events for one Atlas organization, optionally filtered by event type or date range. Returns each event's id, eventTypeName, created date, and related fields such as username and target project. Use this for organization-level activity such as user and billing changes. Use mongodb_project_events_list for one project. Requires an organization id from mongodb_organizations_list.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
event_typearray- Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently. Example: ["JOINED_ORG"]
include_rawboolean- Set to true to include the raw document of each event, which carries extra fields that may change without notice. Atlas defaults to false. Example: false
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
max_datestring- Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. Example: 2026-10-14T00:00:00Z
min_datestring- Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. Example: 2026-10-01T00:00:00Z
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_organization_getGet one Atlas organization by its id.Read-onlyGet Organization
Get one Atlas organization by its id. Returns the organization's id, name, isDeleted flag, and skipDefaultAlertsSettings. Use this when you already have the organization id. Use mongodb_organizations_list to find it.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
mongodb_organization_projects_listList the projects in one Atlas organization, optionally filtered by project name prefix.Read-onlyList Organization Projects
List the projects in one Atlas organization, optionally filtered by project name prefix. Returns each project's id, name, orgId, clusterCount, and created date. Use this to scope projects to one organization. Use mongodb_projects_list for every project the service account can see. Requires an organization id from mongodb_organizations_list.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
namestring- Project name prefix to filter by; the match is case-insensitive. Leave empty to list all. Example: analytics
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_organization_teams_listList the teams in an Atlas organization.Read-onlyList Organization Teams
List the teams in an Atlas organization. Returns each team's id and name. Use this to find team ids. Use mongodb_project_teams_list to see which teams can access a project. Requires an organization id from mongodb_organizations_list.
Inputs
org_idstringrequired- Unique 24-hexadecimal id of the Atlas organization. Get it from mongodb_organizations_list. Example: 4888442a3354817a7320eb61
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_organizations_listList the Atlas organizations the service account can access, optionally filtered by name prefix.Read-onlyList Organizations
List the Atlas organizations the service account can access, optionally filtered by name prefix. Returns each organization's id, name, and isDeleted flag, plus totalCount. Use this to find an organization id. Use mongodb_organization_get for one organization.
Inputs
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
namestring- Organization name prefix to filter by; the match is case-insensitive. Leave empty to list all. Example: Acme
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_process_database_measurements_getGet storage metrics for one database on a MongoDB process, such as data size, index size, and object count.Read-onlyGet Database Metrics
Get storage metrics for one database on a MongoDB process, such as data size, index size, and object count. Returns one measurement series per metric with its name, units, and timestamped dataPoints. Use this for one database's size over time. Use mongodb_process_measurements_get for host-level metrics. Requires a project id and process id from mongodb_processes_list and a database name from mongodb_process_databases_list.
Inputs
database_namestringrequired- Human-readable label that identifies the database that the specified MongoDB process serves. Example: sample_mflix
granularitystringrequired- Duration between data points, as an ISO 8601 duration. Allowed values: PT10S, PT1M, PT5M, PT1H, P1D. Example: PT1H
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
process_idstringrequired- MongoDB process id in hostname:port form, as returned in the id field of mongodb_processes_list. Example: atlas-abc123-shard-00-00.x1y2z.mongodb.net:27017
endstring- Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. Example: 2026-10-14T00:00:00Z
metricsarray- Metric names to return; leave empty for all. Examples: DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_OBJECT_COUNT. Allowed values: DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, DATABASE_VIEW_COUNT. Example: ["DATABASE_DATA_SIZE", "DATABASE_INDEX_SIZE"]
periodstring- How far back from now to read, as an ISO 8601 duration. Set either period or both start and end. Example: P1D
startstring- Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. Example: 2026-10-13T00:00:00Z
mongodb_process_databases_listList the databases on one MongoDB process.Read-onlyList Process Databases
List the databases on one MongoDB process. Returns each database's databaseName. Use this to find a database name for mongodb_process_database_measurements_get. Requires a project id and process id from mongodb_processes_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
process_idstringrequired- MongoDB process id in hostname:port form, as returned in the id field of mongodb_processes_list. Example: atlas-abc123-shard-00-00.x1y2z.mongodb.net:27017
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_process_measurements_getGet time-series metrics for one MongoDB process, such as CPU, connections, opcounters, memory, and disk usage.Read-onlyGet Process Metrics
Get time-series metrics for one MongoDB process, such as CPU, connections, opcounters, memory, and disk usage. Returns one measurement series per metric with its name, units, and timestamped dataPoints. Use this for host-level performance. Use mongodb_process_database_measurements_get for one database's storage metrics. Requires a project id and process id from mongodb_processes_list.
Inputs
granularitystringrequired- Duration between data points, as an ISO 8601 duration. Allowed values: PT10S, PT1M, PT5M, PT1H, P1D. Example: PT1M
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
process_idstringrequired- MongoDB process id in hostname:port form, as returned in the id field of mongodb_processes_list. Example: atlas-abc123-shard-00-00.x1y2z.mongodb.net:27017
endstring- Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. Example: 2026-10-14T06:00:00Z
metricsarray- Metric names to return; leave empty for all. Examples: CONNECTIONS, OPCOUNTER_QUERY, PROCESS_CPU_USER, SYSTEM_MEMORY_USED, QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED. Example: ["CONNECTIONS", "PROCESS_CPU_USER"]
periodstring- How far back from now to read, as an ISO 8601 duration. Set either period or both start and end. Example: PT10H
startstring- Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. Example: 2026-10-14T00:00:00Z
mongodb_processes_listList the MongoDB processes (mongod and mongos hosts) running in one Atlas project.Read-onlyList Processes
List the MongoDB processes (mongod and mongos hosts) running in one Atlas project. Returns each process's id (hostname:port), hostname, port, typeName (for example REPLICA_PRIMARY), replicaSetName, version, and userAlias. Use this to get the process id that the metrics, database and slow-query tools need. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_project_event_getGet one activity feed event from an Atlas project.Read-onlyGet Project Event
Get one activity feed event from an Atlas project. Returns the event's eventTypeName, created date, and related fields such as clusterName, username, and remote address. Use this for one event's details. Use mongodb_project_events_list to find event ids. Requires a project id from mongodb_projects_list and an event id from mongodb_project_events_list.
Inputs
event_idstringrequired- Unique 24-hexadecimal id of the event. Get it from mongodb_project_events_list. Example: 5f4007f327a3bd7b6f4103c9
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
include_rawboolean- Set to true to include the raw document of each event, which carries extra fields that may change without notice. Atlas defaults to false. Example: false
mongodb_project_events_listList the activity feed events for one Atlas project, optionally filtered by cluster, event type, or date range.Read-onlyList Project Events
List the activity feed events for one Atlas project, optionally filtered by cluster, event type, or date range. Returns each event's id, eventTypeName, created date, and related fields such as clusterName, username, and remote address. Use this to audit what changed in a project. Use mongodb_organization_events_list for organization-level events. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
cluster_namesarray- Names of the clusters to return events for. Leave empty for events from every cluster and the project itself. Example: ["Cluster0"]
event_typearray- Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently. Example: ["CLUSTER_UPDATE_SUBMITTED"]
excluded_event_typearray- Category of event that you would like to exclude from query results, such as CLUSTER_CREATED. IMPORTANT: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types. Example: ["DATA_EXPLORER"]
include_rawboolean- Set to true to include the raw document of each event, which carries extra fields that may change without notice. Atlas defaults to false. Example: false
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
max_datestring- Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. Example: 2026-10-14T00:00:00Z
min_datestring- Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. Example: 2026-10-01T00:00:00Z
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_project_getGet one Atlas project by its id.Read-onlyGet Project
Get one Atlas project by its id. Returns the project's id, name, orgId, clusterCount, created date, and tags. Use this when you have the project id. Use mongodb_project_get_by_name when you only know the name. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_project_get_by_nameGet one Atlas project by its exact name.Read-onlyGet Project by Name
Get one Atlas project by its exact name. Returns the project's id, name, orgId, clusterCount, created date, and tags. Use this to turn a project name into the project id other tools need. Use mongodb_project_get when you already have the id.
Inputs
group_namestringrequired- Exact name of the Atlas project. Example: analytics-production
mongodb_project_teams_listList the teams that have access to an Atlas project and their project roles.Read-onlyList Project Teams
List the teams that have access to an Atlas project and their project roles. Returns each team's teamId and roleNames. Use this to see who can manage a project. Use mongodb_organization_teams_list for every team in the organization. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_projects_listList every Atlas project the service account can access, across organizations.Read-onlyList Projects
List every Atlas project the service account can access, across organizations. Returns each project's id (the groupId other tools need), name, orgId, clusterCount, and created date. Use this to find a project id. Use mongodb_project_get_by_name when you know the exact name, or mongodb_organization_projects_list for one organization.
Inputs
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_sample_dataset_load_status_getCheck the progress of a sample dataset load.Read-onlyGet Sample Dataset Load Status
Check the progress of a sample dataset load. Returns the load's clusterName, state (WORKING, COMPLETED or FAILED), createDate, completeDate, and errorMessage. Use this after mongodb_sample_dataset_load. Requires a project id and the _id returned by mongodb_sample_dataset_load.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
sample_dataset_idstringrequired- Id of the sample dataset load request, returned in the _id field by mongodb_sample_dataset_load. Example: 5f4007f327a3bd7b6f4103cb
mongodb_schema_advice_getGet Performance Advisor's schema recommendations for a cluster, such as reducing unbounded arrays or document size.Read-onlyGet Schema Advice
Get Performance Advisor's schema recommendations for a cluster, such as reducing unbounded arrays or document size. Returns content.recommendations, each with a recommendation type, description, and affectedNamespaces. Use this for data-model advice. Use mongodb_suggested_indexes_list for index advice. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_search_index_getGet one Atlas Search or Vector Search index by database, collection, and index name.Read-onlyGet Search Index
Get one Atlas Search or Vector Search index by database, collection, and index name. Returns the index's indexID, type, status, queryable flag, latestDefinition, and per-host statusDetail. Use this to check whether an index is built and queryable. Use mongodb_search_indexes_list_by_collection to find index names. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Name of the collection. Example: movies
database_namestringrequired- Label that identifies the database that contains the collection with one or more Atlas Search indexes. Example: sample_mflix
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
index_namestringrequired- Name of the Atlas Search or Vector Search index. Get it from mongodb_search_indexes_list_by_collection. Example: default
mongodb_search_indexes_listList every Atlas Search and Vector Search index on one cluster.Read-onlyList Search Indexes
List every Atlas Search and Vector Search index on one cluster. Returns each index's indexID, name, database, collectionName, type, status, queryable flag, and latestDefinition. Use this for a whole cluster. Use mongodb_search_indexes_list_by_collection for one collection. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_search_indexes_list_by_collectionList the Atlas Search and Vector Search indexes on one collection.Read-onlyList Search Indexes for Collection
List the Atlas Search and Vector Search indexes on one collection. Returns each index's indexID, name, type, status, queryable flag, and latestDefinition. Use this to scope to one collection. Use mongodb_search_indexes_list for the whole cluster. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Name of the collection. Example: movies
database_namestringrequired- Label that identifies the database that contains the collection with one or more Atlas Search indexes. Example: sample_mflix
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_slow_queries_listList the slow-query log lines Atlas recorded for one MongoDB process.Read-onlyList Slow Queries
List the slow-query log lines Atlas recorded for one MongoDB process. Returns slowQueries entries, each with the namespace and the raw log line; the include flags add parsed metrics, opType, and replicaState. Use this to inspect individual slow operations. Use mongodb_suggested_indexes_list for index recommendations. Requires a project id and process id from mongodb_processes_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
process_idstringrequired- MongoDB process id in hostname:port form, as returned in the id field of mongodb_processes_list. Example: atlas-abc123-shard-00-00.x1y2z.mongodb.net:27017
durationinteger- Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the since parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours. Example: 3600000
include_metricsboolean- Whether or not to include metrics extracted from the slow query log as separate fields. Atlas defaults to false. Example: false
include_op_typeboolean- Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field. Atlas defaults to false. Example: false
include_replica_stateboolean- Whether or not to include the replica state of the host when the slow query log was generated as a separate field. Atlas defaults to false. Example: false
max_logsinteger- Maximum number of lines from the log to return. Atlas defaults to 20000. Example: 100
namespacesarray- Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Example: ["sample_mflix.movies"]
sinceinteger- Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours. Example: 1760400000000
mongodb_suggested_indexes_listList the indexes Atlas Performance Advisor suggests for a cluster, based on its slow queries.Read-onlyList Suggested Indexes
List the indexes Atlas Performance Advisor suggests for a cluster, based on its slow queries. Returns content.suggestedIndexes (namespace, index keys, impact, weight) and content.shapes, the query shapes that would benefit. Use this to find indexes to add. Use mongodb_drop_index_suggestions_list for indexes to remove, or mongodb_slow_queries_list for the raw slow queries. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
namespacesarray- Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Example: ["sample_mflix.movies"]
process_idsarray- Process IDs from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). Example: ["atlas-abc123-shard-00-00.x1y2z.mongodb.net:27017"]
sinceinteger- Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don't specify the until parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours. Example: 1760400000000
untilinteger- Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you specify the until parameter, you must specify the since parameter. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours. Example: 1760486400000
mongodb_system_status_getCheck that the Atlas Administration API is reachable with the connected service account.Read-onlyGet API Status
Check that the Atlas Administration API is reachable with the connected service account. Returns appName, build, the caller's IP address, throttling, and details of the calling credentials. Use this to verify the connection works before other calls.
Inputs
This tool takes no inputs.
mongodb_versions_listList the MongoDB major versions available for new clusters in a project.Read-onlyList MongoDB Versions
List the MongoDB major versions available for new clusters in a project. Returns each available version with its cloudProvider, instanceSize, and defaultStatus. Use this to choose mongodb_major_version for mongodb_cluster_create or an upgrade with mongodb_cluster_update. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
cloud_providerstring- Filter results to only one cloud provider. Allowed values: AWS, AZURE, GCP, TENANT. Example: AWSone of
AWSAZUREGCPTENANT default_statusstring- Filter results to only the default values per tier. This value must be DEFAULT. Allowed values: DEFAULT. Example: DEFAULTone of
DEFAULT instance_sizestring- Filter results to only one instance size. Example: M10
items_per_pageinteger- Number of items per page, from 1 to 500. Atlas defaults to 100. Example: 100
page_numinteger- Page number to return, starting at 1. Atlas defaults to 1. Example: 1
mongodb_access_list_entry_createAdd one IP address, CIDR block, or AWS security group to an Atlas project's IP access list so clients there can connect.WriteAdd IP Access List Entry
Add one IP address, CIDR block, or AWS security group to an Atlas project's IP access list so clients there can connect. Returns the project's full IP access list after the change. Use this to allow a new client network. Use mongodb_access_list_entry_delete to revoke access. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
aws_security_groupstring- AWS security group id to allow (the project needs a VPC peering connection). Set exactly one of ip_address, cidr_block or aws_security_group. Example: sg-0123456789abcdef0
cidr_blockstring- Range of IP addresses in CIDR notation to allow. Set exactly one of ip_address, cidr_block or aws_security_group. Example: 203.0.113.0/24
commentstring- Remark that explains the purpose or scope of this IP access list entry. Example: Office network
delete_after_datestring- Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. Example: 2026-12-31T00:00:00Z
ip_addressstring- Single IP address to allow. Set exactly one of ip_address, cidr_block or aws_security_group. Example: 203.0.113.10
mongodb_alert_acknowledgeAcknowledge an open Atlas alert until a given time so Atlas stops sending notifications for it, or unacknowledge it.WriteAcknowledge Alert
Acknowledge an open Atlas alert until a given time so Atlas stops sending notifications for it, or unacknowledge it. Returns the alert with its acknowledgedUntil, acknowledgementComment, and acknowledgingUsername. Use this to silence an alert you are handling. Use mongodb_alert_config_toggle to disable the alert rule itself. Requires a project id from mongodb_projects_list and an alert id from mongodb_alerts_list.
- Idempotent
Inputs
alert_idstringrequired- Unique 24-hexadecimal id of the alert. Get it from mongodb_alerts_list. Example: 5f4007f327a3bd7b6f4103c7
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
acknowledged_untilstring- Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. Example: 2026-10-15T12:00:00Z
acknowledgement_commentstring- Comment that a MongoDB Cloud user submitted when acknowledging the alert. Example: Investigating high CPU on the primary
unacknowledge_alertboolean- Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter. Example: false
mongodb_alert_config_toggleEnable or disable one Atlas alert configuration without changing its other settings.WriteEnable or Disable Alert Configuration
Enable or disable one Atlas alert configuration without changing its other settings. Returns the alert configuration with its new enabled flag. Use this to switch an alert rule on or off. Use mongodb_alert_acknowledge to silence a single alert. Requires a project id from mongodb_projects_list and an alert configuration id from mongodb_alert_configs_list.
- Idempotent
Inputs
alert_config_idstringrequired- Unique 24-hexadecimal id of the alert configuration. Get it from mongodb_alert_configs_list. Example: 5f4007f327a3bd7b6f4103c8
enabledbooleanrequired- Flag that indicates whether to enable or disable the specified alert configuration in the specified project. Example: true
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_backup_restore_job_createRestore a cluster from a cloud backup snapshot or a point in time into a target cluster, or prepare a snapshot for download.WriteCreate Restore Job
Restore a cluster from a cloud backup snapshot or a point in time into a target cluster, or prepare a snapshot for download. Returns the restore job with its id and deliveryType; poll mongodb_backup_restore_job_get for progress. Use this to recover data. An automated or pointInTime restore overwrites the target cluster's data. Requires a project id and cluster name from mongodb_clusters_list and, for snapshot restores, a snapshot id from mongodb_backup_snapshots_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
delivery_typestringrequired- Human-readable label that categorizes the restore job to create. Allowed values: automated, download, pointInTime. Example: automatedone of
automateddownloadpointInTime group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
oplog_incinteger- Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when "deliveryType" : "pointInTime" and oplogTs exceeds 0. Example: 1
oplog_tsinteger- Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. Example: 1760400000
point_in_time_utc_secondsinteger- Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when "deliveryType" : "pointInTime" and pointInTimeUTCSeconds exceeds 0. Example: 1760400000
snapshot_idstring- Unique 24-hexadecimal character string that identifies the snapshot. Example: 5f4007f327a3bd7b6f4103c5
target_cluster_namestring- Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when "deliveryType": "automated". Required for automated and pointInTime restore types. Example: Cluster1
target_group_idstring- Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName. Required for automated and pointInTime restore types. Example: 32b6e34b3d91647abb20e7b8
mongodb_backup_snapshot_takeTake an on-demand cloud backup snapshot of a cluster now.WriteTake Backup Snapshot
Take an on-demand cloud backup snapshot of a cluster now. Returns the new snapshot with its id and status (queued, then inProgress, then completed). Use this before risky changes. Use mongodb_backup_snapshots_list to see existing snapshots; Atlas rejects the request while another on-demand snapshot is queued or in progress. Requires a project id and cluster name from mongodb_clusters_list; the cluster must have cloud backup enabled.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
descriptionstring- Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status" : "onDemand". Example: Before schema migration
retention_in_daysinteger- Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1. Example: 7
mongodb_cluster_createCreate a dedicated Atlas cluster (M10 or larger) in a project.WriteCreate Cluster
Create a dedicated Atlas cluster (M10 or larger) in a project. Returns the new cluster with its name, stateName CREATING, and the configuration Atlas applied. Use this for dedicated clusters. Use mongodb_flex_cluster_create for a low-cost Flex cluster. Requires a project id from mongodb_projects_list; use mongodb_cloud_provider_regions_list to pick a region.
Inputs
cluster_typestringrequired- Configuration of nodes that comprise the cluster. Allowed values: REPLICASET, SHARDED, GEOSHARDED. Example: REPLICASETone of
REPLICASETSHARDEDGEOSHARDED group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
namestringrequired- Human-readable label that identifies the cluster. Example: Cluster0
replication_specsarrayrequired- List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. Example: [{"regionConfigs": [{"providerName": "AWS", "regionName": "US_EAST_1", "priority": 7, "electableSpecs": {"instanceSize": "M10", "nodeCount": 3}}]}]
backup_enabledboolean- Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Atlas defaults to false. Example: true
mongodb_major_versionstring- MongoDB major version of the cluster. Set to the binary major version. On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. Example: 8.0
pit_enabledboolean- Flag that indicates whether the cluster uses continuous cloud backups. Atlas Infinite clusters always use continuous cloud backups. Atlas sets this flag to true on create and update for Atlas Infinite clusters and ignores a requested value of false. Example: false
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Example: [{"key": "environment", "value": "production"}]
termination_protection_enabledboolean- Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. Atlas defaults to false. Example: false
version_release_systemstring- Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion. Atlas defaults to LTS. Allowed values: LTS, CONTINUOUS. Example: LTSone of
LTSCONTINUOUS
mongodb_cluster_updateUpdate a dedicated Atlas cluster: pause or resume it, scale or move it, upgrade its version, or change backup and protection settings.WriteUpdate Cluster
Update a dedicated Atlas cluster: pause or resume it, scale or move it, upgrade its version, or change backup and protection settings. Fields you leave out stay unchanged. Returns the cluster with its new configuration; stateName shows UPDATING while Atlas applies the change. Use this to change an existing cluster. Use mongodb_cluster_create for a new one, or mongodb_flex_cluster_update for Flex clusters. Requires a project id and cluster name from mongodb_clusters_list.
- Idempotent
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
backup_enabledboolean- Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Atlas defaults to false. Example: true
mongodb_major_versionstring- MongoDB major version of the cluster. Set to the binary major version. On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. Example: 8.0
pausedboolean- Flag that indicates whether the cluster is paused. Example: false
pit_enabledboolean- Flag that indicates whether the cluster uses continuous cloud backups. Atlas Infinite clusters always use continuous cloud backups. Atlas sets this flag to true on create and update for Atlas Infinite clusters and ignores a requested value of false. Example: false
replication_specsarray- List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. Example: [{"regionConfigs": [{"providerName": "AWS", "regionName": "US_EAST_1", "priority": 7, "electableSpecs": {"instanceSize": "M10", "nodeCount": 3}}]}]
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Example: [{"key": "environment", "value": "production"}]
termination_protection_enabledboolean- Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. Atlas defaults to false. Example: false
version_release_systemstring- Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion. Atlas defaults to LTS. Allowed values: LTS, CONTINUOUS. Example: LTSone of
LTSCONTINUOUS
mongodb_custom_role_createCreate a custom database role from specific privilege actions and inherited built-in roles.WriteCreate Custom Database Role
Create a custom database role from specific privilege actions and inherited built-in roles. Returns the new role with its roleName, actions, and inheritedRoles. Use this when built-in roles are too broad; grant the role to users with mongodb_database_user_create or mongodb_database_user_update. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
role_namestringrequired- Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. Example: reportingReader
actionsarray- List of the individual privilege actions that the role grants. Example: [{"action": "FIND", "resources": [{"db": "sales", "collection": "orders"}]}]
inherited_rolesarray- List of the built-in roles that this custom role inherits. Example: [{"db": "admin", "role": "read"}]
mongodb_custom_role_updateReplace a custom database role's actions or inherited roles; a list you send replaces the current list.WriteUpdate Custom Database Role
Replace a custom database role's actions or inherited roles; a list you send replaces the current list. Returns the updated role. Use this to change an existing role. Use mongodb_custom_role_create for a new one. Requires a project id from mongodb_projects_list and a role name from mongodb_custom_roles_list.
- Idempotent
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
role_namestringrequired- Name of the custom database role. Get it from mongodb_custom_roles_list. Example: reportingReader
actionsarray- List of the individual privilege actions that the role grants. Example: [{"action": "FIND", "resources": [{"db": "sales", "collection": "orders"}]}]
inherited_rolesarray- List of the built-in roles that this custom role inherits. Example: [{"db": "admin", "role": "read"}]
mongodb_database_user_createCreate a database user in an Atlas project so applications can connect to its clusters.WriteCreate Database User
Create a database user in an Atlas project so applications can connect to its clusters. Returns the new user with its username, databaseName, roles, and scopes (the password is not returned). Use this to add a user. Use mongodb_database_user_update to change an existing user's password or roles. Requires a project id from mongodb_projects_list.
Inputs
database_namestringrequired- The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. Allowed values: admin, $external. Example: adminone of
admin$external group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
rolesarrayrequired- List that provides the pairings of one role with one applicable database. Example: [{"databaseName": "sales", "roleName": "readWrite"}]
usernamestringrequired- Human-readable label that represents the user that authenticates to MongoDB. Example: app-user
aws_iam_typestring- Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. Atlas defaults to NONE. Allowed values: NONE, USER, ROLE. Example: NONEone of
NONEUSERROLE delete_after_datestring- Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request. Example: 2026-12-31T00:00:00Z
descriptionstring- Description of this database user. Example: Read-only user for the reporting service
ldap_auth_typestring- Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. Atlas defaults to NONE. Allowed values: NONE, GROUP, USER. Example: NONEone of
NONEGROUPUSER oidc_auth_typestring- Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field. Atlas defaults to NONE. Allowed values: NONE, IDP_GROUP, USER. Example: NONEone of
NONEIDP_GROUPUSER passwordstring- Alphanumeric string that authenticates this database user against the database specified in databaseName. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response. Example: S3cure-Passw0rd!
scopesarray- List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Workspaces that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Workspaces in the project. Example: [{"name": "Cluster0", "type": "CLUSTER"}]
x509_typestring- X.509 method that MongoDB Cloud uses to authenticate the database user. - For application-managed X.509, specify MANAGED. - For self-managed X.509, specify CUSTOMER. Users created with the CUSTOMER method require a Common Name (CN) in the username parameter. You must create externally authenticated users on the $external database. Atlas defaults to NONE. Allowed values: NONE, CUSTOMER, MANAGED. Example: NONEone of
NONECUSTOMERMANAGED
mongodb_database_user_updateUpdate an Atlas database user's roles, password, scopes, description, or expiry.WriteUpdate Database User
Update an Atlas database user's roles, password, scopes, description, or expiry. Roles are always required and replace the user's current roles; other fields you leave out stay unchanged. Returns the updated user (the password is not returned). Use this to rotate a password or change roles. Use mongodb_database_user_create for a new user. Requires a project id and the user's authentication database and username from mongodb_database_users_list; read the current roles with mongodb_database_user_get.
- Idempotent
Inputs
database_namestringrequired- Authentication database of the user: admin for password (SCRAM) users, $external for AWS IAM, X.509, LDAP and OIDC users. Example: admin
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
rolesarrayrequired- Complete list of roles the user should have after the update; it replaces the current list. Each entry pairs a roleName with the databaseName it applies to (and optionally a collectionName). Example: [{"databaseName": "sales", "roleName": "readWrite"}]
usernamestringrequired- Username of the database user, exactly as Atlas stores it (for SCRAM users the plain name; for AWS IAM, X.509, LDAP or OIDC users the ARN, DN or IdP identifier). Get it from mongodb_database_users_list. Example: app-user
delete_after_datestring- Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request. Example: 2026-12-31T00:00:00Z
descriptionstring- Description of this database user. Example: Read-only user for the reporting service
passwordstring- Alphanumeric string that authenticates this database user against the database specified in databaseName. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response. Example: N3w-Passw0rd!
scopesarray- List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Workspaces that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Workspaces in the project. Example: [{"name": "Cluster0", "type": "CLUSTER"}]
mongodb_flex_cluster_createCreate a low-cost Atlas Flex cluster in a project.WriteCreate Flex Cluster
Create a low-cost Atlas Flex cluster in a project. Returns the new Flex cluster with its name, stateName CREATING, and providerSettings. Use this for development or small workloads. Use mongodb_cluster_create for a dedicated cluster. Requires a project id from mongodb_projects_list.
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
namestringrequired- Human-readable label that identifies the instance. Example: FlexCluster0
provider_settingsobjectrequired- Group of cloud provider settings that configure the provisioned MongoDB flex cluster. Example: {"backingProviderName": "AWS", "regionName": "US_EAST_1"}
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. Example: [{"key": "environment", "value": "production"}]
termination_protection_enabledboolean- Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. Atlas defaults to false. Example: false
mongodb_flex_cluster_updateChange an Atlas Flex cluster's termination protection or tags; fields you leave out stay unchanged.WriteUpdate Flex Cluster
Change an Atlas Flex cluster's termination protection or tags; fields you leave out stay unchanged. Returns the updated Flex cluster. Use this for Flex clusters. Use mongodb_cluster_update for dedicated clusters. Requires a project id and Flex cluster name from mongodb_flex_clusters_list.
- Idempotent
Inputs
cluster_namestringrequired- Human-readable label that identifies the flex cluster. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. Example: [{"key": "environment", "value": "production"}]
termination_protection_enabledboolean- Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. Atlas defaults to false. Example: false
mongodb_maintenance_window_updateChange the weekly maintenance window of an Atlas project, or start pending maintenance now.WriteUpdate Maintenance Window
Change the weekly maintenance window of an Atlas project, or start pending maintenance now. Returns an empty response on success. Use this to move maintenance out of busy hours. Use mongodb_maintenance_window_get to read the current window. Requires a project id from mongodb_projects_list.
- Idempotent
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
auto_defer_once_enabledboolean- Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. This setting controls the same underlying auto-deferral feature as the /maintenanceWindow/autoDefer endpoint. Use either this field (to set a specific value) or that endpoint (to toggle the current value). Example: false
day_of_weekinteger- Day of the week the maintenance window starts, in the project's time zone: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday. Example: 7
hour_of_dayinteger- Hour of the day (0 to 23, in the project's time zone) the maintenance window starts; 0 is midnight and 12 is noon. Example: 3
protected_hoursobject- Daily window in which Atlas won't start maintenance, given as startHourOfDay and endHourOfDay (0 to 23). Example: {"startHourOfDay": 9, "endHourOfDay": 17}
start_asapboolean- Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to false after MongoDB Cloud completes maintenance. Example: false
mongodb_project_createCreate a new Atlas project in an organization.WriteCreate Project
Create a new Atlas project in an organization. Returns the new project with its id, name, orgId, and created date. Use this to add a project. Use mongodb_project_update to rename or retag an existing one. Requires an organization id from mongodb_organizations_list.
Inputs
namestringrequired- Human-readable label that identifies the project included in the MongoDB Cloud organization. Example: analytics-staging
org_idstringrequired- Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs. Example: 4888442a3354817a7320eb61
project_owner_idstring- Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. Example: 5f4007f327a3bd7b6f4103d1
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. Example: [{"key": "environment", "value": "production"}]
with_default_alerts_settingsboolean- Flag that indicates whether to create the project with default alert settings. Example: true
mongodb_project_updateRename an Atlas project or replace its tags; fields you leave out stay unchanged.WriteUpdate Project
Rename an Atlas project or replace its tags; fields you leave out stay unchanged. Returns the updated project with its id, name, and tags. Use this to change an existing project. Use mongodb_project_create for a new one. Requires a project id from mongodb_projects_list.
- Idempotent
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
namestring- Human-readable label that identifies the project included in the MongoDB Cloud organization. Example: analytics-production
tagsarray- List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. Example: [{"key": "environment", "value": "production"}]
with_default_alerts_settingsboolean- Flag that indicates whether the project can automatically create default alerts. Example: true
mongodb_rolling_index_createBuild a regular MongoDB index on a collection one replica set member at a time, so the build doesn't block the primary.WriteCreate Rolling Index
Build a regular MongoDB index on a collection one replica set member at a time, so the build doesn't block the primary. Returns an empty response once Atlas accepts the request; Atlas then builds the index in the background. Use this for indexes Performance Advisor suggests (mongodb_suggested_indexes_list). Use mongodb_search_index_create for Atlas Search or Vector Search indexes. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Human-readable label of the collection for which MongoDB Cloud creates an index. Example: movies
database_namestringrequired- Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index. Example: sample_mflix
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
keysarrayrequired- Index keys as a list of single-field objects, in key order. Each value is "1" (ascending), "-1" (descending), "text", "2dsphere" or "hashed". Example: [{"year": "1"}, {"title": "1"}]
collationobject- One or more settings that specify language-specific rules to compare strings within this index. Example: {"locale": "en", "strength": 2}
optionsobject- Index options such as name, sparse, hidden, partialFilterExpression, or expireAfterSeconds for a TTL index. Example: {"name": "year_title_idx", "sparse": false}
mongodb_sample_dataset_loadLoad MongoDB's sample datasets (sample_mflix, sample_airbnb and others) into a cluster.WriteLoad Sample Dataset
Load MongoDB's sample datasets (sample_mflix, sample_airbnb and others) into a cluster. Returns the load request with its _id and state (WORKING, then COMPLETED or FAILED). Use this to give a new cluster example data. Poll mongodb_sample_dataset_load_status_get with the returned _id. Requires a project id from mongodb_projects_list and a cluster name from mongodb_clusters_list or mongodb_flex_clusters_list.
Inputs
cluster_namestringrequired- Human-readable label that identifies the cluster into which you load the sample dataset. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_search_index_createCreate an Atlas Search (full-text) or Vector Search index on a collection.WriteCreate Search Index
Create an Atlas Search (full-text) or Vector Search index on a collection. Returns the new index with its indexID, name, type, and status (IN_PROGRESS while it builds, STEADY when ready). Use this to add an index. Use mongodb_search_index_update to change an existing index's definition. Requires a project id and cluster name from mongodb_clusters_list.
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Label that identifies the collection to create an Atlas Search index in. Example: movies
database_namestringrequired- Label that identifies the database that contains the collection to create an Atlas Search index in. Example: sample_mflix
definitionobjectrequired- Index definition. For type search, set mappings (and optionally analyzers and synonyms), for example {"mappings": {"dynamic": true}}. For type vectorSearch, set fields with at least one vector field giving path, numDimensions and similarity (euclidean, cosine or dotProduct), for example {"fields": [{"type": "vector", "path": "embedding", "numDimensions": 1536, "similarity": "cosine"}]}. Example: {"mappings": {"dynamic": true}}
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
index_namestringrequired- Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. Example: default
typestring- Type of the index. The default type is search. Allowed values: search, vectorSearch. Example: searchone of
searchvectorSearch
mongodb_search_index_updateReplace the definition of an Atlas Search or Vector Search index; Atlas rebuilds the index in the background.WriteUpdate Search Index
Replace the definition of an Atlas Search or Vector Search index; Atlas rebuilds the index in the background. Returns the index with its new latestDefinition and status. Use this to change mappings or vector fields. Use mongodb_search_index_create for a new index. Requires a project id and cluster name from mongodb_clusters_list and the index name from mongodb_search_indexes_list_by_collection.
- Idempotent
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Name of the collection. Example: movies
database_namestringrequired- Label that identifies the database that contains the collection with one or more Atlas Search indexes. Example: sample_mflix
definitionobjectrequired- Complete new index definition; it replaces the current one. For a search index, set mappings, for example {"mappings": {"dynamic": false, "fields": {"title": {"type": "string"}}}}. For a vectorSearch index, set fields, for example {"fields": [{"type": "vector", "path": "embedding", "numDimensions": 1536, "similarity": "cosine"}]}. Example: {"mappings": {"dynamic": false, "fields": {"title": {"type": "string"}}}}
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
index_namestringrequired- Name of the Atlas Search or Vector Search index. Get it from mongodb_search_indexes_list_by_collection. Example: default
mongodb_access_list_entry_deleteRemove one entry from an Atlas project's IP access list; clients from that address can no longer connect.DestructiveDelete IP Access List Entry
Remove one entry from an Atlas project's IP access list; clients from that address can no longer connect. Returns an empty response on success. Use this to revoke access. Use mongodb_access_list_entry_create to add an entry. Requires a project id and the entry value from mongodb_access_list_entries_list.
- Idempotent
Inputs
entry_valuestringrequired- The access list entry to act on: an IP address, a CIDR block with its slash URL-encoded as %2F, or an AWS security group id. Get it from mongodb_access_list_entries_list. Example: 192.0.2.0%2F24
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_cluster_deleteDelete a dedicated Atlas cluster and its data.DestructiveDelete Cluster
Delete a dedicated Atlas cluster and its data. Returns an empty response once Atlas accepts the request; the cluster then moves to stateName DELETING. Use this to remove a dedicated cluster. Use mongodb_flex_cluster_delete for Flex clusters. Atlas rejects the request while terminationProtectionEnabled is true. Requires a project id and cluster name from mongodb_clusters_list.
- Idempotent
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
retain_backupsboolean- Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. Example: false
mongodb_custom_role_deleteDelete a custom database role from a project.DestructiveDelete Custom Database Role
Delete a custom database role from a project. Returns an empty response on success. Use this to remove a role no user needs. Use mongodb_custom_role_update to change it instead. Requires a project id from mongodb_projects_list and a role name from mongodb_custom_roles_list.
- Idempotent
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
role_namestringrequired- Name of the custom database role. Get it from mongodb_custom_roles_list. Example: reportingReader
mongodb_database_user_deleteDelete a database user from an Atlas project; applications using it can no longer connect.DestructiveDelete Database User
Delete a database user from an Atlas project; applications using it can no longer connect. Returns an empty response on success. Use this to remove a user. Use mongodb_database_user_update to change one instead. Requires a project id and the user's authentication database and username from mongodb_database_users_list.
- Idempotent
Inputs
database_namestringrequired- Authentication database of the user: admin for password (SCRAM) users, $external for AWS IAM, X.509, LDAP and OIDC users. Example: admin
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
usernamestringrequired- Username of the database user, exactly as Atlas stores it (for SCRAM users the plain name; for AWS IAM, X.509, LDAP or OIDC users the ARN, DN or IdP identifier). Get it from mongodb_database_users_list. Example: app-user
mongodb_flex_cluster_deleteDelete an Atlas Flex cluster and its data.DestructiveDelete Flex Cluster
Delete an Atlas Flex cluster and its data. Returns an empty response on success. Use this for Flex clusters. Use mongodb_cluster_delete for dedicated clusters. Requires a project id and Flex cluster name from mongodb_flex_clusters_list.
- Idempotent
Inputs
cluster_namestringrequired- Human-readable label that identifies the flex cluster. Example: Cluster0
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_project_deleteDelete an Atlas project permanently.DestructiveDelete Project
Delete an Atlas project permanently. Returns an empty response on success. Use this to remove a project you no longer need; delete its clusters first with mongodb_cluster_delete. Atlas refuses while any Online Archives remain on the project's clusters. Requires a project id from mongodb_projects_list.
- Idempotent
Inputs
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
mongodb_search_index_deleteDelete an Atlas Search or Vector Search index from a collection.DestructiveDelete Search Index
Delete an Atlas Search or Vector Search index from a collection. Returns an empty response once Atlas accepts the request. Use this to remove an index. Use mongodb_search_index_update to change it instead. Requires a project id and cluster name from mongodb_clusters_list and the index name from mongodb_search_indexes_list_by_collection.
- Idempotent
Inputs
cluster_namestringrequired- Name of the cluster. Get it from mongodb_clusters_list. Example: Cluster0
collection_namestringrequired- Name of the collection. Example: movies
database_namestringrequired- Label that identifies the database that contains the collection with one or more Atlas Search indexes. Example: sample_mflix
group_idstringrequired- Unique 24-hexadecimal id of the Atlas project (Atlas calls it groupId). Get it from mongodb_projects_list. Example: 32b6e34b3d91647abb20e7b8
index_namestringrequired- Name of the Atlas Search or Vector Search index. Get it from mongodb_search_indexes_list_by_collection. Example: default
No tools match.
