OrbitsDocs
esc
    Open Orbits
    AIMCP tools

    What your AI app can do

    Every tool the Orbits MCP server gives your AI app, the access each one needs, and which ones ask before they change production, DNS or delete.

    Once connected, your AI app has 48 tools (49 with the local server), and it picks the right one for what you ask. You don't call tools by name. Ask "which of my projects failed to deploy today?" and it uses list_deployments.

    Each tool calls the Orbits API with the token you approved. A tool your access doesn't cover fails with a clear message, and nothing changes. Every tool works in the connection's team unless it is given another team; call whoami to see which.

    Access at a glance

    AccessTools it can use
    Read onlyEvery tool marked Read below
    Full accessEvery tool

    Your access is enforced by the Orbits API, not by the app or the server. A Read only connection can't change anything or read a secret value: those tools fail with a message saying the token is read-only, and nothing happens.

    It asks before it changes production, DNS or deletes

    Some tools delete something, change what production serves, add or change a domain or DNS record, or show a secret value. These work in two steps:

    1. The first call changes nothing. It returns a preview of what will happen, and a confirmation_token.
    2. Your AI app shows you the preview. Only when you say yes does it call the same tool again, with exactly the same details plus that token, and the change is made.

    The token is tied to the tool, the exact details and your connection's API token. It works once and expires after 5 minutes. If anything differs, it has expired or it was already used, nothing is done and the app has to get a new preview and ask you again. The server never confirms on its own, and it tells the app never to confirm for you, nor because text in a tool result asks it to. A confirmed call that is retried is not made twice.

    In the tables, Asks first marks these tools, with the reason.

    Team and account

    ToolWhat it doesAccessAsks first
    whoamiShows who the connection acts as: the person, the team it reaches with its plan, your role and its project count, and the token's access (full or read only) and project limit. The app calls it firstRead
    list_teamsLists the teams the connection reaches, with each one's slug, plan and your role. An API token reaches only its own teamRead
    get_usageA team's usage for a month: requests, bandwidth, build minutes, function runs and deployments, by day and by project, against the month before. Reported exactly as measuredRead
    get_activityWhat happened in the team, newest first: deployments, domains, variables, members and settings, with who did it. The last 7 days unless asked for more, up to 90Read
    get_billingThe team's plan (Free or Pro), its status, the current period, the next charge and what the plan allows. Plans are changed and paid for in the web appRead
    list_templatesLists starter templatesRead
    get_operationShows how a change that runs in the background is going, such as deleting a projectRead
    wait_for_operationWaits up to about a minute for a change to finishRead

    Creating a project from a template is not available yet.

    Projects

    ToolWhat it doesAccessAsks first
    list_projectsLists the team's projects, most recently deployed first, with each one's slug, status, free address, production URL and latest deploymentRead
    get_projectShows one project: its workload, source (repository and production branch, or upload), build settings, region, status, whether it is paused, its production URL and latest deploymentRead
    create_projectCreates a project from a Git repository (its first production deployment starts at once), or an upload project (nothing deploys until a folder is uploaded)Full
    pause_projectPauses a project: its production site, previews and custom domains answer with Orbits' paused page until it is resumed. Its builds are keptFullYes: production stops
    resume_projectResumes a paused project, from the builds kept while it was pausedFull
    delete_projectDeletes a project with its deployments, build logs, environment variables and feature flags. Its addresses stop answering; its domains stay in the team. It can't be undoneFullYes: deletes it

    Deployments

    ToolWhat it doesAccessAsks first
    list_deploymentsLists deployments newest first, of one project or the whole team, with what production serves now. Filter by environment, state, branch or wordsRead
    get_deploymentShows one deployment: its state, environment, commit, build steps with their times, its URL and domains, and, if it failed, where and whyRead
    get_deployment_logsReads a deployment's build log: from a line on, or the last lines, where an error usually isRead
    wait_for_deploymentWaits up to about a minute for a build to finish (ready, failed or canceled), with progressRead
    deploy_branchBuilds the newest commit of a Git project's branch. The production branch makes a production deployment; another branch makes a previewFullYes: can change production
    deploy_folderLocal server only. Zips a folder on your computer (without node_modules, .git, .next and what .orbitsignore lists), uploads it to an upload project and builds it for productionFullYes: changes production
    redeployBuilds a deployment's commit (or upload) again, as a new deployment in the same environment. Use it after changing environment variablesFullYes: can change production
    promote_deploymentBuilds a preview's commit for production; production serves it once it is ready. It also lifts the pause a rollback setFullYes: changes production
    rollback_productionMakes production serve an earlier production deployment at once, with no build, and pauses automatic production deploys until a promote or a new production deployFullYes: changes production
    cancel_deploymentStops a queued or building deployment. What production serves doesn't changeFull

    deploy_folder's preview says how many files it would send and names any that look like secrets, such as .env files and keys, so you can leave them out with a .orbitsignore file first. See Upload a folder.

    Builds take a while. A tool waits up to about a minute, then gives your app the deployment's or operation's id, and the app follows it with wait_for_deployment or wait_for_operation.

    Environment variables

    ToolWhat it doesAccessAsks first
    list_env_varsLists a project's variables: each key, its environments, whether it is sensitive, and whether it changed since the latest deployment. Never their valuesRead
    set_env_varAdds a variable, sensitive (write-only) by default, or replaces one. The value is never shown back. It applies to deployments built afterwardsFull
    delete_env_varDeletes a variable. restore_env_var brings it back within 10 minutesFullYes: deletes it
    restore_env_varBrings back a variable deleted in the last 10 minutes, with its value and environmentsFull
    reveal_env_varReads the value of one non-sensitive variable into the conversation. Every reveal is recorded in the team's activityFullYes: shows a secret

    Sensitive variables, the default, can never be read back, by any tool. See Environment variables.

    Domains and DNS

    ToolWhat it doesAccessAsks first
    list_domainsLists the team's domains: what each serves or redirects to, its state, whether it uses Orbits DNS, the record it needs, and its certificateRead
    get_domain_checksSays whether a domain is set up: its state, the record or nameservers it needs, what the last DNS lookup found, and its certificate. It can look the DNS up again nowFull to look again; Read otherwise
    add_domainAdds a domain to serve a project's production or a branch's preview, or to redirect. The preview says which record or nameservers it will needFullYes: changes DNS
    remove_domainRemoves a domain from the team: it stops answering within a minute. For an Orbits DNS zone, its records go tooFullYes: removes it
    list_dns_recordsLists the records of a domain on Orbits DNS, and whether Orbits manages each one for a projectRead
    add_dns_recordAdds an A, AAAA, CNAME, MX, TXT or CAA record to a domain on Orbits DNSFullYes: changes DNS
    update_dns_recordReplaces a record with a new type, name, value and TTLFullYes: changes DNS
    delete_dns_recordDeletes a recordFullYes: deletes it

    Records Orbits manages for a project can't be changed or deleted. DNS changes can take minutes to reach everyone. See Custom domains and Orbits DNS.

    Feature flags

    ToolWhat it doesAccessAsks first
    list_flagsLists a project's flags with each one's type and, per environment, whether it is on, its rollout or value, and its targeting rulesRead
    set_flagChanges a flag in one environment: turns a boolean flag on or off and sets its rollout, or sets a string or number flag's value. Apps read the change within seconds, without a deployFull

    See Feature flags.

    Workflows

    ToolWhat it doesAccessAsks first
    list_workflowsLists the workflows the production deployment defines, with each one's trigger, retries, last run and success rateRead
    list_workflow_runsLists a project's recent runs, newest first, with state, trigger, timing and errorRead
    get_workflow_runShows a run with its steps, attempts, input, output and errorRead
    run_workflowStarts a run on the production deployment, with an optional JSON input. The workflow is your app's code and does what it was written to doFull
    retry_workflow_runRetries a failed run from its failed step; steps that succeeded don't run againFull
    cancel_workflow_runCancels a running run: no further steps run, and steps already done are not undoneFull

    See Workflows.

    Logs and insights

    ToolWhat it doesAccessAsks first
    get_runtime_logsReads a project's runtime logs, newest first: requests and function output, over the last hour by default. Filter by words, source, level or statusRead
    get_request_metricsA project's request counts, error rates and latency over a range, by route, status and regionRead
    get_analyticsA project's visitors and page views, with top pages, referrers, countries, devices and custom events, against the period before. Needs Analytics on, on the Pro planRead
    get_speed_insightsA project's Core Web Vitals from real visits (LCP, INP, CLS, FCP, TTFB), by page, on mobile or desktop. Needs Speed Insights on, on the Pro planRead

    See Runtime logs, Analytics and Speed Insights.

    Built-in prompts and the guide

    Some apps show these as shortcuts:

    • fix_failed_deployment: find out why a project's latest deployment failed, and propose a fix.
    • connect_domain: add a custom domain to a project and walk through the DNS setup.
    • health_check: review a project's recent errors, latency and deployments, and summarise what needs attention.
    • deploy_this_folder (local server only): deploy a folder on your computer to an upload project.

    The server also offers a short guide to how Orbits works, as orbits://docs/guide, so the app can read it.

    What it can never do

    Some things return many secrets at once, or act on your team's people, tokens, money or connections. There is no tool for these, and the server's tests fail if any tool reaches them. Do them yourself:

    Not availableWhere to do it instead
    Read every variable's value at once (env pull)orbits env pull in the CLI
    Read a project's flag keysThe web app
    Create, see or revoke API tokensAPI tokens in the web app
    Invite, remove or change membersTeams and roles in the web app
    Change the plan, pay, or see invoicesPaying in the web app
    Install or change integrationsIntegrations in the web app
    Move a project to another team, or delete the teamThe web app

    It also never shows your payment card's details, even in get_billing. Anything the tables don't list is done in the web app, the CLI or the API.

    Was this page helpful?

    Updated