Setup

This page gets Scout running on your machine with three context providers: the web, the filesystem (the Scout repo itself), and a CRM (people, projects, notes) backed by Postgres.

Prerequisites

Docker Desktop (install)
OpenAI API key (get one)

Manual
Agentic

Clone and configure

git clone https://github.com/agno-agi/scout && cd scout
cp example.env .env

Open .env and set OPENAI_API_KEY. Everything else has sensible defaults.

Start Scout

docker compose up -d --build

First run pulls the base image and builds the Scout container. Takes a minute or two. Subsequent starts come up in seconds.

Verify it's running

curl http://localhost:8000/health

Expect {"status":"ok"}. Connection refused means the container is still starting. Check docker compose logs -f scout-api and wait for the Agno banner.

If you have a coding agent like Claude Code or Codex, paste this prompt into a fresh session in an empty directory. The agent clones the repo, starts Scout, and verifies it’s running.The prompt below never asks the agent to read or transmit your API key. The agent opens .env for you to edit, then waits for you to confirm before continuing.

Set up Scout locally for me.

Steps:
Clone https://github.com/agno-agi/scout into the current directory and cd into it.
Copy example.env to .env. Open .env in the user's editor (or print the path and tell them to open it). Tell the user: "Set OPENAI_API_KEY in .env, save the file, then tell me to continue." Wait for confirmation before proceeding. Do not ask the user to paste the key into this chat. Do not read the key from .env or print its value at any point.
Check that Docker Desktop is running (`docker info`). If not, tell me to start it and stop.
Run `docker compose up -d --build`. Stream the output so I can see progress.
Poll `curl -s http://localhost:8000/health` every 3 seconds for up to 60 seconds. Proceed once it returns `{"status":"ok"}`.
Run `curl -s http://localhost:8000/contexts | jq` and show me the output so I can see which contexts registered.
Print next steps: open os.agno.com, Add OS → Local → http://localhost:8000.

If any step fails, stop and show me the error. Don't try to fix it on your own.

Connect to AgentOS UI

Open os.agno.com and log in. Click Add OS, choose Local, enter http://localhost:8000, click Connect. Try the pre-configured prompt: “Which contexts are you connected to?” Scout reports back web, filesystem, and CRM.

What you have now

Scout is running with three context providers. Each surfaces as a query_<id> tool (plus update_<id> where writes are allowed):

Provider	Tool(s)	Backed by
Web	`query_web`	Parallel’s public MCP (keyless). Set `PARALLEL_API_KEY` to upgrade to the Parallel SDK.
Filesystem	`query_fs`	The Scout repo itself, read-only.
CRM	`query_crm`, `update_crm`	Your own contacts, projects, and notes in the local Postgres.

Try it

Ask Scout to put each provider to work:

“Look up the latest pricing for Anthropic’s models.” hits the web.

“Search the repo for where context providers get registered.” navigates the filesystem.

“Save Sarah Chen as a contact, she’s the head of platform at Acme.” writes to the CRM.

Connect to Slack →

Welcome

Tutorials

Runtime

Demo OS

Prerequisites

Connect to AgentOS UI

What you have now

Try it

Next

Welcome

Tutorials

Runtime

Demo OS

​Prerequisites

​Connect to AgentOS UI

​What you have now

​Try it

​Next

Prerequisites

Connect to AgentOS UI

What you have now

Try it

Next