Skip to content

Quick start: connect your agent

Add Auto to your agent as an MCP server. Your agent starts Auto on your computer when it connects, and guides you through the rest.

Before you start

You need npx, which comes with Node.js 26.10 or later, on macOS or Linux, and an agent that runs on your computer, such as Claude Code, Codex, Gemini CLI, Grok, Cursor or Claude Desktop.

1. Add Auto to your agent

Tell your agent:

text
Add Auto as an MCP server named auto-runtime that runs this command:
npx -y @on.auto/runtime@0.11.0 mcp
Then reload your MCP servers.

Or add it yourself:

bash
claude mcp add -s user auto-runtime -- npx -y @on.auto/runtime@0.11.0 mcp
bash
codex mcp add auto-runtime -- npx -y @on.auto/runtime@0.11.0 mcp
bash
gemini mcp add -s user auto-runtime npx -y @on.auto/runtime@0.11.0 mcp
bash
grok mcp add -s user auto-runtime npx -- -y @on.auto/runtime@0.11.0 mcp
json
{
  "mcpServers": {
    "auto-runtime": {
      "command": "npx",
      "args": ["-y", "@on.auto/runtime@0.11.0", "mcp"]
    }
  }
}

The entry names a release of Auto. The first time your agent runs it, npx downloads that release from npm, and your agent keeps to it until you change the version in the entry.

Cursor reads the JSON from ~/.cursor/mcp.json, and Claude Desktop from Settings → Developer → Edit Config; keep any servers already there. Then restart your agent, or start a new session, so it loads Auto.

2. Let your agent take it from there

Ask your agent:

text
Use auto-runtime to list my playbooks and the models it can use.

The first time, Auto starts in the background. It keeps running after your agent closes, so your workflows carry on and your next session finds it ready.

Auto runs your work with an AI model of its own, so it needs an API key from a model provider: Anthropic, OpenAI or Google. Your agent's subscription does not cover it. Until there is a key, your agent tells you to put one line such as ANTHROPIC_API_KEY= followed by your key in ~/.auto-runtime/.env, and restarts Auto once you have saved it. Never paste the key into the conversation. For Amazon Bedrock, Azure OpenAI, Google Vertex AI or your own gateway, see Set up a model provider.

Once Auto lists your models, your agent offers to create your first function. Continue with Build your first playbook, and later Build your first workflow. To let a function look things up while it runs, see Give a function tools.

See and control Auto

Open http://localhost:5555 to see which release of Auto runs, since when and from which folder, with buttons that restart and stop it. From a terminal, npx @on.auto/runtime status, restart and stop do the same. Both control Auto only in local mode, which is how your agent starts it. Your work is saved in ~/.auto-runtime/ledger.db, and Auto writes its log to ~/.auto-runtime/runtime.log.

Other ways to run Auto

  • In a terminal. npx @on.auto/runtime starts Auto in the window you run it in, reading its settings from a .env in that folder, and shows how to connect your agent. An agent with the entry above uses it while it runs.
  • Signed in with your Auto account. Auto on your computer runs in local mode: nobody signs in, and what you make belongs to an organization called local. To sign in instead, start Auto in a terminal with PUBLIC_URL=http://localhost:5555 in that folder's .env, and connect your agent over HTTP, such as claude mcp add --transport http auto-runtime http://localhost:5555/mcp. Auto then offers no restart or stop: press Ctrl+C in its terminal to stop it.
  • Your team's Auto. Connect your agent to its address, such as claude mcp add --transport http auto-runtime https://auto.example.com/mcp.
  • On a server for your team. See Self-hosting. Do not expose Auto on your computer through a tunnel or public proxy.

If something does not work

  • Your agent cannot start Auto. Ask it to run the entry's command with --version in place of mcp, and show you what it prints. On a Node.js older than 26.10, Auto says which version it needs: install Node.js 26.10 or later. If Claude Desktop cannot find npx, set command to its full path, which which npx prints.
  • No models appear. Check the line in ~/.auto-runtime/.env, then restart Auto. A model name that ends in *, such as anthropic/*, stands for a family of models: it is not a model to run.
  • Another program uses port 5555. Set PORT to a free port in ~/.auto-runtime/.env; both Auto and the MCP entry read it.

Troubleshooting covers more.