Tutorial 01 — Building an Agent¶
Quick commands¶
From this directory (docs/tutorials/01-building-an-agent):
Overlays declare tool refs as <library>:<path>. The prefix is always a
library name. These overlays use the samples library from
mas-library-samples, which mas-lab-workspace installs. A lab can
also ship a library next to lab-config.yaml: list the path under
lab.libraries, or put library.yaml in an immediate child directory.
Lab-local library names win over workspace config and installed libraries.
When to use a lab vs a library vs a local plugin:
labs-and-libraries.md.
# Live chat with tools, a skill, and memory
mas-ctl chat agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-o overlays/memory.yaml \
-q "What is the current price of Apple?"
# Operator steering mid-run (interactive session)
mas-ctl chat agent.yaml -i -o overlays/tools.yaml --trace
# then type: /steer Use web search for stock prices, not fruit.
# TUI — same manifest/overlays
mas-ctl tui agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml
Deployment: deployments/local-inproc.yaml (default runtime).
Packages:
mas-ctl(chat/validate),mas-runtime(contracts/plugins),mas-lab(plots/benchmarks) Time: ~30 min hands-on Goal: Go from an empty YAML file to a working QA agent with tools, a skill, and memory — then run it via CLI and API. Prerequisite: complete Tutorial 0 first. It coverstask install,$XDG_CONFIG_HOME/mas/config.yaml, infra bundles, data/trace cache paths, and API keys. Offline validation steps run without an LLM; live runs needdefault_infraor--infra-refplusOPENAI_API_KEYin.env.
Overview¶
The MAS Framework defines agents declaratively. An agent manifest is a YAML file
(kind: Agent) that describes what the agent does — not how it does it.
The runtime handles the rest: design pattern execution, tool invocation,
context management, observability.
In this tutorial you will:
- Write a minimal agent manifest (3 fields) and run it
- Add tools via an overlay — no manifest duplication
- Stack a skill overlay on top
- Stack memory + event tracing — see the agent think in real time
- Explore the CLI modes
- Serve the agent card via HTTP
- Inspect the trace: raw
events.jsonl→ trajectory / multilevel plots
Each step adds an --overlay to the CLI command — the base agent.yaml
never changes.
Every step builds on the previous one — you can stop at any point and have a working agent.
Step 1 — The minimal manifest¶
This is agent.yaml — the base manifest for the entire tutorial:
apiVersion: mas/v1
kind: Agent
metadata:
name: qa-agent
spec:
description: "Answer general knowledge questions."
context:
intent: "Answer general knowledge questions."
role: |
Answer questions clearly and concisely.
That's it. Everything else has sensible defaults:
| Field | Default | Meaning |
|---|---|---|
spec.models[0].model |
any (compile sentinel) |
Main LLM. Pin a LiteLLM id, or inherit MAS / experiment.models.main, then local config.yaml defaults.model. |
spec.design_pattern |
react |
ReAct loop. Shorthand design_pattern: react ≡ {type: react, params: {max_cot_pass: 1, parallel: true}} — no max_steps unless a production overlay such as with-hardened sets 512. plugin-bindings.md |
spec.assembler |
assembler |
Builds messages[]. Omit ≡ {type: assembler, params: {emit_segments: true, always_reassemble: false}} — context-assembly.md |
spec.context_manager |
summarising |
Last 10 user turns verbatim; summarizer: llm; hysteresis 0.2 — summarization.md · context-assembly.md |
Don't take this table's word for it — mas-ctl compile agent.yaml prints the
real, fully-expanded object for every one of these plugins (and the
summarizer sub-plugin one level down). See
Compiled agent defaults for exactly that
output against this file, or run it yourself once you've read Step 5 below.
Key insight: The manifest is a specification, not a configuration file. It declares the agent's capabilities and intent. The runtime resolves how to execute it based on the active flavour (
localby default — runmas-ctl flavour listto see the bundled flavours).
How the runtime connects the manifest to an LLM¶
Four layers separate concerns:
agent.yaml flavour (lib-standard) infra/ .env.local
┌──────────┐ ┌──────────────┐ ┌──────────────┐ ┌──────────┐
│ WHAT │ │ HOW │ │ WHERE │ │ SECRET │
│ model │ │ protocol │ │ model serving │ │ API key │
│ context │ │ plugins │ │ tool providers│ │ value │
│ tools │ │ → infra ref │ │ OTel collector│ │ │
└──────────┘ └──────────────┘ └──────────────┘ └──────────┘
(agent identity) (deployment profile) (providers) (personal)
- Agent — what it does: model (
gpt-4o-mini), context, tools, plugins - Flavour — how it's deployed: protocol + plugins (local in-process vs remote agent-remote). Infra refs come from workspace/CLI, not the flavour
- Infrastructure — where services are: model proxy endpoint, tool providers, OTel collector
- Credentials — the secret value (API key) in
.env.local, never committed
The model name in the manifest (gpt-4o-mini) is a canonical name — it never
changes regardless of which cloud backend is used. Infrastructure maps it to the
wire name (gpt-4o-mini, vertex_ai/..., etc.) at startup.
Tools and skills are resolved by proximity: the runtime looks for them next to
the manifest first, then falls back to the standard library.
Flavours are not shipped by the tutorial — they are kind: Flavour
manifests bundled in mas-library-standard. List the installed ones:
mas-ctl flavour list
# standard:local ← development default (this tutorial)
# standard:local-benchmark ← batch benchmark runs
The default is local; select another with the optional --flavour flag
(only local is wired into chat/tui today). The bundled local flavour:
# mas-library-standard: flavours/local.yaml — development default
spec:
llm:
provider: openai
temperature: 0.7
max_tokens: 2000
agent_comm:
protocol: agent-local # in-process delegation (MAS topology)
mode: local
tools:
remote_tools_enabled: false # tools resolved in-process, not via servers
allowed: ["*"]
telemetry:
backend: file # lightweight file-based traces
path: logs/
A future production flavour would flip these knobs (remote tool servers, OTLP
telemetry, trace_content: false) with zero changes to the agent
manifest — that separation is the whole point of flavours.
Before a live LLM run, set your API key (Tutorial 0 §4):
# At repo root or tutorial directory
echo 'OPENAI_API_KEY=sk-…' >> .env # gitignored — never commit
source .env
With default_infra: standard:production in $XDG_CONFIG_HOME/mas/config.yaml, you do not
need --infra-ref on every command. This tutorial does not pin an LLM backend;
live chat uses Tutorial 0 infra. Record/replay without calling the provider is
the llm_cache middleware (llm-cache.md).
Run it¶
First, validate the manifest against the schema:
cd docs/tutorials/01-building-an-agent
mas-ctl validate agent.yaml
Then run a single query:
mas-ctl -v chat agent.yaml -q "What is the capital of France?"
Or start an interactive REPL (type quit to exit):
mas-ctl chat agent.yaml -i
What happened¶
The runtime loaded the manifest, resolved the local flavour, loaded
infrastructure (model provider, tool provider), instantiated the default
ReAct design pattern, and ran a single-turn LLM call. No tools were declared
yet, so the ReAct loop short-circuited to a direct answer.
Step 2 — Adding tools via overlay¶
Instead of editing agent.yaml, we overlay new capabilities on top.
An overlay is a partial manifest that merges into the base — only the fields
you declare are changed; everything else stays. The --overlay flag applies it:
Validate the overlay first:
mas-ctl validate agent.yaml -o overlays/tools.yaml
Then run:
mas-ctl -v chat agent.yaml \
-o overlays/tools.yaml \
-q "If Tokyo has 14 million people and Paris has 2.1 million, how many times larger is Tokyo?"
overlays/tools.yaml adds tools and updates the role prompt (spec.context.role):
# overlays/tools.yaml
spec:
context:
role: |
Answer questions clearly and concisely.
When you need to perform calculations, use the calc tool.
When you need current information from the web, use the web-search tool.
tools:
- web-search
- calculator
Tools are referenced by semantic name — web-search, calculator. The
runtime binds them to actual Python modules or tool servers at startup; the
agent manifest never references implementation details.
The ReAct loop now has two tools. With -v you see the exchange:
[qa-agent] AGENT -> TOOL (calculator): {'expression': '14000000 / 2100000'}
[qa-agent] TOOL (calculator) -> AGENT: {'result': 6.666...}
Step 3 — Stacking a skill overlay¶
Skills are markdown documents that give the agent domain expertise.
They are referenced by semantic name — just like tools — and resolved
via proximity search (skills/ next to the manifest → mas.library.standard/skills/).
# overlays/skills.yaml
spec:
skills:
- answer-formatting
The runtime finds skills/answer-formatting/SKILL.md automatically.
No skills_dir needed. That file must start with YAML frontmatter
(--- then name / description) so discovery can index it. A leading
copyright comment before the frontmatter is treated as a body with no name.
Listing the skill is enough: activate_skill is added as a system tool
(it is not exposed unless at least one skill is listed; see
System tools). Frontmatter
description is the when-to-use text shown in the catalog. It should also
tell the model to activate_skill("answer-formatting") and follow the
loaded body. The body is how to apply the skill and is not in the catalog.
Stack it on top of the tools overlay with a second --overlay:
mas-ctl validate agent.yaml \
-o overlays/tools.yaml -o overlays/skills.yaml
mas-ctl -v chat agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-q "Who is the current president of the United States?"
Overlays are applied left-to-right. Each one merges into the result of the previous merge. The base
agent.yamlis never modified. Fields declared in a later overlay win over earlier ones; list fields (tools, skills) are appended.
The catalog lists that frontmatter description, so the model is prompted to
call activate_skill("answer-formatting") and then follow the formatting
rules from the skill body — a one-sentence summary, supporting bullets, and
a HIGH / MEDIUM / LOW confidence line.
Step 4 — Adding memory¶
Memory is a resource, not a tool. The agent accesses it through two paths: proactive context injection (RAG) and reactive tool calls. This tutorial covers the practical setup end-to-end.
Like tools and skills, memory is declared by name — the runtime resolves the right plugin bundle:
# overlays/memory.yaml
spec:
memory: semantic # ephemeral (in-memory) — no filesystem dependency
tools:
- memory-search # exposes memory_search, memory_get, memory_store
Two memory modes are available:
| Name | Storage | Use when |
|---|---|---|
semantic |
In-memory (:memory:) |
Tests, benchmarks, CI — each run starts clean |
semantic-persistent |
$XDG_DATA_HOME/mas/memory/{agent_id}.sqlite |
Interactive demos where memory must survive across sessions |
Both wire the same SemanticMemoryPlugin — hybrid search (vector + FTS),
proactive RAG injection into the user message, and the memory-search tool
provider (memory_search, memory_get, memory_store). The only
difference is whether the SQLite database lives on disk or vanishes when
the process exits.
The demo below uses ephemeral memory (semantic) — Run 1 shows a user
correction being stored within a session, Run 2 uses a seed overlay to
pre-populate memory at startup.
Stack all three overlays:
mas-ctl validate agent.yaml \
-o overlays/tools.yaml -o overlays/skills.yaml \
-o overlays/memory.yaml
mas-ctl -v chat agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-o overlays/memory.yaml \
-q "What is the current price of Apple?"
The -v flag prints each agent operation to stderr (LLM calls, tool
round-trips, latencies):
[qa-agent] AGENT -> TOOL (web_search): {'query': 'current price apples'}
[qa-agent] TOOL (web_search) -> AGENT: {'results': [...]} (1205ms)
Run 1 — Ambiguous question → Correction + Memory store¶
Memory is ephemeral by default (in-memory SQLite) — each process starts clean with no filesystem dependency.
mas-ctl -v chat agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-o overlays/memory.yaml \
-q "What is the current price of Apple?" \
-q "No, I meant Apple the fruit, not the stock. Remember this for next time."
Turn 1 — The ambiguous question (empty memory):
You: What is the current price of Apple?
The agent interprets "Apple" as the stock (AAPL) — common LLM behaviour with no prior context:
🤖 llm call → gpt-4o-mini (2 messages)
🔧 tool call → web_search({'query': 'current price of Apple stock'})
✓ web_search → {'summary': 'Stock Price - Apple: ... $258.83 ...'}
Agent: The current price of Apple Inc. (AAPL) stock is approximately $258.83.
Turn 2 — The user corrects and the agent stores to semantic memory:
You: No, I meant Apple the fruit, not the stock. Remember this for next time.
The agent calls memory_store to record the correction:
🔧 tool call → memory_store({
'content': "User prefers information about Apple the fruit ...",
'source': 'user_preference'
})
✓ memory_store → {'status': 'stored', 'doc_id': '3b7c6427...'}
Agent: Got it! I'll remember that you're asking about apple the fruit.
Since memory is ephemeral, the stored preference vanishes when the process exits. Run 2 shows how to pre-seed that knowledge into a fresh process.
Run 2 — Pre-seeded memory, single shot (new process)¶
A seed overlay pre-populates semantic memory at startup — same effect as if the agent had learned the preference in a previous session:
# overlays/memory-seed.yaml
spec:
memory_seed:
- source: user_preference
content: >
User always refers to the fruit when asking about 'Apple',
not the stock.
Stack it on top of the memory overlay:
mas-ctl -v chat agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-o overlays/memory.yaml \
-o overlays/memory-seed.yaml \
-q "What is the current price of Apple?"
The SemanticMemoryPlugin proactively injects the seeded preference into
the user message before the LLM sees it:
→ LLM sees: "[Relevant memories — apply these before answering]
- User always refers to the fruit when asking about 'Apple' ...
What is the current price of Apple?"
🔧 tool call → web_search({'query': 'current price of Apple fruit'})
Agent: The current price of apple fruit is approximately $1.56 per pound.
The proof: same question as Turn 1 of Run 1, opposite answer — in a brand new process with zero conversation history. The seeded memory resolved the ambiguity on the first turn. Without the seed overlay, the agent defaults to stock (as seen in Run 1).
For cross-session persistence (memory survives across processes), use
memory: semantic-persistent— stores at$XDG_DATA_HOME/mas/memory/{agent_id}.sqlite. See the memory modes table above.For deeper implementation details on runtime behavior and manifests, see the local docs listed in the "Going further" section below.
Step 5 — Running via CLI¶
You've already used -q for single queries and multi-turn scripted
conversations. Here are the other modes:
Interactive REPL¶
mas-ctl chat agent.yaml -i \
-o overlays/tools.yaml \
-o overlays/skills.yaml
Tool exchanges are printed automatically in interactive mode.
Single query with pipe¶
echo "What is the GDP of France?" | mas-ctl -v chat agent.yaml
Selecting a flavour¶
# Default flavour (local) — explicit form is optional
mas-ctl chat agent.yaml -i --flavour local
# Offline / no API key — llm_cache replay (see docs/manifests/llm-cache.md)
mas-ctl chat agent.yaml -i --infra-ref standard:openai \
--infra-ref library-samples/infra/llm-cache-replay.yaml
The optional --flavour NAME flag selects a deployment flavour bundled in
mas-library-standard (see mas-ctl flavour list); it defaults to local,
the only flavour wired into chat/tui today. Passing an unsupported name
(e.g. --flavour prod) exits with an error listing what's available. This
tutorial's config.yaml does not pin an LLM backend. Offline runs use
llm_cache replay, not a flavour.
The agent manifest is the same in all cases — only the deployment posture changes.
CLI-only agent (no YAML)¶
You can also add tools, skills, and memory directly from the command line — useful for quick experiments without writing any YAML files:
mas-ctl -v chat agent.yaml -i \
--tool web-search \
--tool calc \
--skill answer-formatting \
--memory semantic
This is equivalent to stacking overlays/tools.yaml, overlays/skills.yaml,
and overlays/memory.yaml. Tools and skills are added by semantic name —
the same names you'd write under spec.tools / spec.skills in YAML.
| Flag | Effect |
|---|---|
--tool NAME |
Add a tool by semantic name (repeatable) |
--skill NAME |
Add a skill by name (repeatable) |
--memory NAME |
Enable a memory backend (semantic, semantic-persistent) |
--set KEY=VALUE |
Set a spec.context key (repeatable) |
CLI flags are applied after all --overlay files, so they can override
or extend any overlay.
Overlay progression¶
One base manifest, overlays stacked with --overlay:
| Step | Command | What's new |
|---|---|---|
| 1 | agent.yaml alone |
Minimal: context.intent + context.role |
| 2 | + overlays/tools.yaml |
+ tools: web-search, calculator |
| 3 | + overlays/skills.yaml |
+ skills: answer-formatting |
| 4 | + overlays/memory.yaml |
+ memory resource (plugin) + context injection + memory-search tool |
The file agent-final.yaml is a commented snapshot of that merge. Generate
the live equivalent with mas-ctl compile (overlays
applied, runtime defaults filled):
mas-ctl compile agent.yaml \
-o overlays/tools.yaml \
-o overlays/skills.yaml \
-o overlays/memory.yaml \
-O compiled-agent.yaml
Full flags, MAS folder vs single-file layouts, and examples: compile command reference.
Validate the snapshot:
mas-ctl validate agent-final.yaml
Step 6 — Serve the agent card over HTTP¶
Expose the same agent manifest through the A2A protocol without changing the agent definition:
mas-ctl serve agent.yaml --infra-ref infra/a2a-qa.yaml
infra/a2a-qa.yaml is an Application endpoint named qa-agent (the agent
metadata.name) with protocol: a2a, usage: deploy, and
url: http://127.0.0.1:9005. mas-ctl chat with the same --infra-ref
binds that URL in the background while you talk on stdin.
In another terminal, retrieve the card and send a test message with the official
A2A CLI or another compatible client. Stop the server with Ctrl-C when done.
The complete protocol walkthrough and current conformance evidence are in the A2A documentation.
Scenario YAML and automated checks¶
This tutorial ships demo/scenario.yaml — a structured walkthrough with
commands and expected exit codes. CI runs the offline steps automatically:
# From repository root
pytest tests/tutorials/test_scenario_commands.py -v -k tuto-01
Live mas-ctl chat steps need TUTORIAL_ONLINE=1 and a configured LLM (Tutorial 0).
Key takeaways¶
- Spec-first: define what the agent does, not how
- Defaults matter: ReAct, summarising context, model — you get a capable agent with 3 fields
- Overlays compose:
--overlaystacks features without duplication - Tools by name: the agent says
web-search; the runtime binds it to a Python module or tool server — the agent manifest never sees implementation details - Skills are markdown: domain knowledge injected into the system prompt
- Memory is a resource, not a tool: two access paths (proactive RAG injection +
memory_searchtool) share the same plugin - Flavours separate deployment from identity:
--flavourselects a deployment posture bundled inmas-library-standard(localtoday; remote tool-servers / OTel are future flavours) with zero manifest changes - CLI flags: same manifest —
-qfor scripted queries,-ifor interactive REPL - Protocol exposure:
mas-ctl serve --infra-ref(orchat/run-maswith the same infra) exposes an agent card without rewriting the manifest
Step 7 — Inspecting the trace¶
Pass --events (with --events-file to choose the path) to capture structured
observability events to traces/events.jsonl. This is raw observability data —
let's turn it into something useful.
Two ways to turn observability on. The
--events/--events-fileCLI flags are the quick, ad-hoc path — good for a single interactive run like this one. The declarative path is a flavour: an observability plugin whose config sets the trace file and format, applied when you deploy or benchmark a MAS (Tutorial 3). A flavour's observability applies to the whole run (every agent writes to one sharedevents.jsonl, tagged peragent_id). The CLI flags are effectively the same plugin wired up for you — think of them as a built-in observability overlay. To scope tracing to a single agent, attach the plugin on that agent's instance rather than at the flavour level.
7a — The raw event stream¶
Re-run the agent with the tools overlay and capture the events (the tool call makes the trace show a full ReAct loop: LLM → tool → LLM):
mas-ctl chat agent.yaml -o overlays/tools.yaml \
-q "What is 15 * 23?" \
--events --events-file traces/events.jsonl
cat traces/events.jsonl | head -5
{"kind": "mas_call_start", "agent_id": "agent", "run_id": "run-…", "turn_id": "u1", "call_id": "mas-…"}
{"kind": "execution_start", "agent_id": "agent", "call_id": "u1-exec", "input": "What is 15 * 23?"}
{"kind": "llm_call_start", "agent_id": "agent", "correlation_id": 1, "call_id": "llm-1"}
{"kind": "context_assembled", "agent_id": "agent", "correlation_id": 1, "segments": 3, "total_tokens": 210}
{"kind": "llm_call_end", "agent_id": "agent", "correlation_id": 1, "call_id": "llm-1"}
Each line is a self-contained JSON event with the agent name, timestamp,
trace ID, and event-specific payload. The dp_state field (when present)
captures the design pattern's internal state — which ReAct iteration,
think/act/observe phase, and reasoning text.
7b — Trajectory diagrams¶
Next: Tutorial 8 replaces or replays this native stream as OTel. Tutorial 9 turns it into a knowledge graph.
Knowledge-graph normalization is Tutorial 9 (
mas-library-kg). This tutorial plots trajectories directly fromevents.jsonl.
Render the event stream as an interactive multilevel trajectory — swim lanes for the session, the agent(s), and the individual LLM/tool/processing calls, with hover cards showing each step's input/output:
# Interactive HTML (recommended) — self-contained, d3 bundled (works offline)
mas-lab plot multilevel-trajectory traces/events.jsonl --format html -o output/trajectory.html
# Static SVG
mas-lab plot multilevel-trajectory traces/events.jsonl --format svg -o output/trajectory.svg
Open output/trajectory.html in a browser. Reading the diagram:
- Lanes (rows) are levels of the run: Session → MAS → Agents → Calls. A lower lane expands the bar above it — the Calls lane is what the agent actually did inside its turn.
- Bars (coloured) are actions/transitions: an LLM call, a tool call, or a
⚙ contextstep (context assembly — where the system prompt is prepended to the turn). Hover a bar to see its input/output. - State boxes (
S1,S2, … the white/numbered boxes between bars) are the state of the world at that instant — the content that exists after the preceding action and before the next one.S1is the user's question; the state after⚙ contextis the fully assembled prompt (system + user); a state after an LLM tool-call turn shows what it decided to call next. Click a state to see its content and the context-provenance breakdown (which parts of the prompt came from where, and their token counts).
So a single-agent ReAct turn reads: user question → ⚙ context → assembled
prompt → LLM → (tool call) → tool → LLM → answer. For a single agent you'll see
one Agent lane; Tutorial 2's MAS run fans this out into one lane per agent with
delegation handoffs (moderator → specialist → moderator …).
The multilevel trajectory is produced by the
multilevel_trajectoryplot in themas-labbench library (mas.lab.plots.multilevel_trajectory); it is also exposed as theplot_multilevel_trajectorypipeline step (Tutorial 3). Each library plot/step/plugin will get its own reference page as the docs grow.This is what you'll automate in Tutorial 3 — experiments define pipelines that extract trajectories and generate these plots for every run automatically.
Going further¶
These docs are not required to complete this tutorial — read them when you want to understand the underlying mechanics:
- Glossary — manifest vocabulary
- User guide — install and CLI workflows
- Contributing — extension points
Teaching notes (optional)¶
If you present this tutorial (~20 min), a useful slide arc:
- Motivation — declarative agents vs imperative frameworks
- Minimal manifest — three fields and sensible defaults
- Tool declaration —
kind: Toolspec vs Pythonimpl - Live ReAct demo
- Progressive enrichment — tools → skills → memory
- Agentic memory — Apple ambiguity example across two runs
- Contracts and control — kernel ingress/egress (see Mealy guide)
- CLI vs protocol — same manifest,
mas-ctl serve --infra-ref(A2A Application endpoint) - Teaser — multiple agents (Tutorial 2)
Next¶
→ Tutorial 2: Creating a Multi-Agent System — compose a 4-agent trip planner MAS with tool/skill catalogs, routing topology, and overlay-driven topology switching.