Skip to content

Update page structure of server quickstart, additional small edits #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
feorlen wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update page structure of server quickstart, additional small edits #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions concepts/evaluators/built-in-evaluators.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Flexible value matching with multiple modes and logic options.
| `logic` | string | `"any"` | `"any"` = match any value, `"all"` = match all |
| `match_on` | string | `"match"` | `"match"` = trigger when found, `"no_match"` = trigger when NOT found |
| `match_mode` | string | `"exact"` | `"exact"` = full string match, `"contains"` = word-boundary match |
| `case_sensitive` | bool | `false` | Case sensitivity |
| `case_sensitive` | bool | `False` | Case sensitivity |

<Note>
`match_mode="contains"` uses word-boundary matching, not generic substring matching. For example, `"admin"` will match `"admin user"` but will NOT match `"sysadministrator"`.
Expand All @@ -96,7 +96,7 @@ Flexible value matching with multiple modes and logic options.
"values": ["admin", "root", "sudo", "superuser"],
"logic": "any",
"match_mode": "contains",
"case_sensitive": false
"case_sensitive": False
Copy link
Author

@feorlen feorlen Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example did not work for me because false was undefined. Both "false" and False worked, changed this to False to make it more obvious it is a bool.

}
}

Expand Down
50 changes: 25 additions & 25 deletions core/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,54 +4,54 @@ description: Install Agent Control, start the server, and protect your first age
icon: "rocket"
---

Protect your AI agent in 4 simple steps.
The instructions on this page describe two ways to install Agent Control for testing in your local environment:

- Quick setup using prebuilt Docker images.
- Local development using the `agent-control` GitHub repository.

## Prerequisites

- **Python 3.12+**

- **Docker**
- **uv**

- **Docker** — for quick setup

- **Node.js 18+** — for the local development web dashboard (optional)

This tutorial was tested on macOS.
Copy link
Author

@feorlen feorlen Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this was tested on macOS, but not which versions. It would be good to add version detail if available.

Just sticking this line here isn't my favorite, but it's a clue if someone runs into trouble on their system. Thorough testing of OS requirements is beyond the scope of this PR.

For me, it worked on Ubuntu 24.04 but not 22.04.


<Tip>
**Quick setup (no repo cloning required)** - Copy this into your terminal or directly paste into your coding agent to start the Agent Control server, UI:
## Install Agent Control

### Quick setup (Docker)

To start the Agent Control server and UI, copy the following command into your terminal or paste into your coding agent:

```bash
curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/main/docker-compose.yml | docker compose -f - up -d
```

Then, install sdk in your virtual env:
Then, install the SDK in your virtual environment:

```bash
uv venv
source .venv/bin/activate
uv pip install agent-control-sdk
```

**What this does:**
What this does:

- ✅ Starts Agent Control server at `http://localhost:8000`
- ✅ Starts UI dashboard at `http://localhost:8000`
- ✅ Installs Python SDK (`agent-control-sdk`)

**Next:** Jump to [Step 3: Register your agent](#step-3-register-your-agent)

</Tip>


**Alternatively**, for local development with the Agent Control repository, clone the repo and follow all steps below.


## Step 1: Start the Agent Control Server

Startup AgentControl server manually for local development.

### Local development (cloning the repo)
Confirm you can access the Agent Control UI at `http://localhost:8000` and continue to [Register your agent](#register-your-agent).

Prerequisites:
### Local development (GitHub repository)

- **uv** — Fast Python package manager (`curl -LsSf https://astral.sh/uv/install.sh | sh`)
Start the AgentControl server manually for local development.

- **Node.js 18+** — For the web dashboard (optional)
#### Clone the repository and start Agent Control

```bash

Expand Down Expand Up @@ -80,15 +80,15 @@ make ui-dev

> 💡 **Verify the server:** Open [http://localhost:8000/health](http://localhost:8000/health) — you should see `{"status": "healthy", "version": "..."}`.

## Step 2: Install the SDK
#### Install the SDK
Copy link
Author

@feorlen feorlen Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

H4s are less than ideal but work. Perhaps revisit with a larger overhaul in the future.


In your agent application project:

```bash
uv pip install agent-control-sdk
```

## Step 3: Register Your Agent
## Register Your Agent

Agent must be registered with the server. You should also add `@control` decorator around tools and LLM call functions.

Expand Down Expand Up @@ -128,7 +128,7 @@ async def main():
asyncio.run(main())
```

## Step 4: Add Controls
## Add Controls

The easiest way to add controls is through the UI — see the [UI Quickstart](/core/ui-quickstart) for a step-by-step guide. Alternatively, use the SDK as shown below or call the API directly.

Expand Down
4 changes: 2 additions & 2 deletions core/ui-quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ The Agent Control dashboard lets you manage [controls](/concepts/controls) and m

## Prerequisites

Before starting the UI, make sure the **Agent Control server** is already running. If you haven't set it up yet, follow the [Quickstart](/core/quickstart) first.
Before starting the UI, make sure the **Agent Control server** is already running. If you haven't set it up yet, follow the [Quickstart](/core/quickstart) first. This tutorial was tested on macOS.
Copy link
Author

@feorlen feorlen Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See OS comment in quickstart.mdx:
https://github.com/agentcontrol/docs-agent-control/pull/33/changes#diff-b279faa1402fe1e0b0dfeff874d1773ce46febc4d973c2de214dae4380a7a7f8R22


You also need:

- **Node.js 20+** (CI uses 20; 18+ may work)
- **pnpm 9+** — install from [pnpm.io](https://pnpm.io/) or run `corepack enable && corepack prepare pnpm@latest --activate`

> **Note:** If you started the server using **One-line setup** from the [Quickstart](/core/quickstart), the UI is already running at [http://localhost:4000](http://localhost:4000). You can skip the setup steps below and jump directly to [viewing the dashboard](#create-controls-from-the-ui).
> **Note:** If you started the server using **One-line setup** from the [Quickstart](/core/quickstart), the UI is already running at [http://localhost:4000](http://localhost:4000). You can skip the setup steps below and jump directly to [Create Controls from the UI](#create-controls-from-the-ui) to add a control.
Copy link
Author

@feorlen feorlen Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original text for this link was not clear where it was sending you. Updated to match the target header.

## Start the UI Server

Expand Down