For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Docs Menu

agentengine atlas setup

Check Atlas setup for the current workspace.

Show the workspace’s current Atlas link state and guide connecting Atlas resources with a service account.

--yes runs a non-interactive path: it creates the Atlas deployment resources with defaults and uploads the generated secrets without displaying them. Under delegated setup, --yes also authorizes billed cluster creation and the required project-wide Atlas IP access-list changes.

When the Agent Engine project already holds MONGODB_URI or VOYAGE_API_KEY and the local Atlas metadata names no matching resource, delegated setup asks whether to keep each one. --yes keeps them; --force replaces them.

When the local Atlas metadata names a database user or Voyage API key whose platform secret is missing, delegated setup rotates the user’s password or offers a replacement Voyage API key. --yes does both without prompting.

When this workspace has memory off (features.memory is false or absent in agent.yaml), setup skips Voyage API key creation and upload. An existing project VOYAGE_API_KEY is left unchanged.

Free and shared-tier Atlas clusters (M0, M2, M5) are not supported for agent deploys: they pause automatically after inactivity, which drops them from platform egress sync, and they cap Atlas Search indexes. The cluster picker hides them and names the ones it hides. Setup and atlas cluster save refuse one, including a saved cluster or one that already holds the cluster name. Use a Flex or dedicated (M10+) cluster.

agentengine atlas setup [flags]
--base-url string Platform base URL
--context string Named context to target (see 'agentengine context list')
--env string Atlas environment to use (for example, cloud-dev)
--force Reset the local Atlas link and rerun setup. The platform Atlas link is unchanged until setup completes
-h, --help help for setup
--org-id string Organization ID
--profile string Atlas service account profile to use
--project-id string Project ID
--workspace string Monorepo: set up Atlas for a specific workspace by name
--workspace-id string Workspace ID
-y, --yes Accept defaults, upload generated secrets without displaying them, and authorize billed cluster creation and Atlas IP access changes without prompts
--log-file string override log file path
--log-level string file log verbosity (error|warn|info|debug) (default "info")
--no-log disable file logging
-q, --quiet silence stderr below error
-v, --verbose count raise stderr verbosity (-v info, -vv debug)
Rate this page