357 lines
17 KiB
HTML
357 lines
17 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Basic Agents - VAPORA Platform Documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff">
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Provide site root and default themes to javascript -->
|
||
|
|
<script>
|
||
|
|
const path_to_root = "../";
|
||
|
|
const default_light_theme = "light";
|
||
|
|
const default_dark_theme = "dark";
|
||
|
|
</script>
|
||
|
|
<!-- Start loading toc.js asap -->
|
||
|
|
<script src="../toc.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="mdbook-help-container">
|
||
|
|
<div id="mdbook-help-popup">
|
||
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
|
|
<div>
|
||
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
||
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="body-container">
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script>
|
||
|
|
try {
|
||
|
|
let theme = localStorage.getItem('mdbook-theme');
|
||
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script>
|
||
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
|
|
let theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
const html = document.documentElement;
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add("js");
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script>
|
||
|
|
let sidebar = null;
|
||
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
} else {
|
||
|
|
sidebar = 'hidden';
|
||
|
|
}
|
||
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<!-- populated by js -->
|
||
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
|
|
<noscript>
|
||
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
|
|
</noscript>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
|
|
<div class="sidebar-resize-indicator"></div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</label>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../tutorials/02-basic-agents.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script>
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="tutorial-2-basic-agents"><a class="header" href="#tutorial-2-basic-agents">Tutorial 2: Basic Agents</a></h1>
|
||
|
|
<p>Learn how to register agents and execute tasks.</p>
|
||
|
|
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>Complete <a href="01-getting-started.html">01-getting-started.md</a></li>
|
||
|
|
<li>VAPORA built: <code>cargo build</code></li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="learning-objectives"><a class="header" href="#learning-objectives">Learning Objectives</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>Register agents in the agent registry</li>
|
||
|
|
<li>Define agent capabilities and metadata</li>
|
||
|
|
<li>Execute agent tasks</li>
|
||
|
|
<li>Query agent status</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="step-1-create-agent-registry"><a class="header" href="#step-1-create-agent-registry">Step 1: Create Agent Registry</a></h2>
|
||
|
|
<p>An <code>AgentRegistry</code> manages all registered agents.</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>use vapora_agents::AgentRegistry;
|
||
|
|
|
||
|
|
let registry = AgentRegistry::new(10); // capacity: 10 agents
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h2 id="step-2-define-agent-metadata"><a class="header" href="#step-2-define-agent-metadata">Step 2: Define Agent Metadata</a></h2>
|
||
|
|
<p>Each agent has a role, capabilities, and LLM provider.</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>use vapora_agents::{AgentMetadata, AgentStatus};
|
||
|
|
|
||
|
|
let agent = AgentMetadata::new(
|
||
|
|
"developer".to_string(), // role
|
||
|
|
"Developer Alice".to_string(), // name
|
||
|
|
"claude".to_string(), // provider
|
||
|
|
"claude-opus-4-5".to_string(), // model
|
||
|
|
vec!["coding".to_string(), "testing".to_string()], // capabilities
|
||
|
|
);
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h2 id="step-3-register-agent"><a class="header" href="#step-3-register-agent">Step 3: Register Agent</a></h2>
|
||
|
|
<p>Add the agent to the registry.</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>let agent_id = registry.register_agent(agent)?;
|
||
|
|
println!("Agent registered: {}", agent_id);
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h2 id="step-4-query-registry"><a class="header" href="#step-4-query-registry">Step 4: Query Registry</a></h2>
|
||
|
|
<p>List all agents or get specific agent.</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// Get all agents
|
||
|
|
let all_agents = registry.list_all();
|
||
|
|
|
||
|
|
// Get specific agent
|
||
|
|
let agent = registry.get_agent(&agent_id)?;
|
||
|
|
println!("Agent status: {:?}", agent.status);
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h2 id="running-the-example"><a class="header" href="#running-the-example">Running the Example</a></h2>
|
||
|
|
<pre><code class="language-bash">cargo run --example 01-simple-agent -p vapora-agents
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="expected-output"><a class="header" href="#expected-output">Expected Output</a></h2>
|
||
|
|
<pre><code>=== Simple Agent Registration Example ===
|
||
|
|
|
||
|
|
Created agent registry with capacity 10
|
||
|
|
Defined agent: "Developer A" (role: developer)
|
||
|
|
Capabilities: ["coding", "testing"]
|
||
|
|
|
||
|
|
Agent registered successfully
|
||
|
|
Agent ID: <uuid>
|
||
|
|
|
||
|
|
=== Registered Agents ===
|
||
|
|
Total: 1 agents
|
||
|
|
- Developer A (Role: developer, Status: Ready, Capabilities: coding, testing)
|
||
|
|
Retrieved agent: Developer A (Status: Ready)
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="concepts"><a class="header" href="#concepts">Concepts</a></h2>
|
||
|
|
<h3 id="agentregistry"><a class="header" href="#agentregistry">AgentRegistry</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Thread-safe registry for managing agents</li>
|
||
|
|
<li>Capacity-limited (prevents resource exhaustion)</li>
|
||
|
|
<li>In-memory storage</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="agentmetadata"><a class="header" href="#agentmetadata">AgentMetadata</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Unique ID (UUID)</li>
|
||
|
|
<li>Role: developer, reviewer, architect, etc.</li>
|
||
|
|
<li>Capabilities: coding, testing, documentation, etc.</li>
|
||
|
|
<li>LLM Provider: claude, gpt-4, gemini, ollama</li>
|
||
|
|
<li>Model: specific version (opus, sonnet, etc.)</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="agentstatus"><a class="header" href="#agentstatus">AgentStatus</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Ready</strong>: Available for task assignment</li>
|
||
|
|
<li><strong>Busy</strong>: Executing tasks</li>
|
||
|
|
<li><strong>Offline</strong>: Not available</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="common-patterns"><a class="header" href="#common-patterns">Common Patterns</a></h2>
|
||
|
|
<h3 id="register-multiple-agents"><a class="header" href="#register-multiple-agents">Register Multiple Agents</a></h3>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>let agents = vec![
|
||
|
|
AgentMetadata::new(...),
|
||
|
|
AgentMetadata::new(...),
|
||
|
|
];
|
||
|
|
|
||
|
|
for agent in agents {
|
||
|
|
registry.register_agent(agent)?;
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h3 id="filter-by-capability"><a class="header" href="#filter-by-capability">Filter by Capability</a></h3>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>let all_agents = registry.list_all();
|
||
|
|
let developers = all_agents
|
||
|
|
.iter()
|
||
|
|
.filter(|a| a.role == "developer")
|
||
|
|
.collect::<Vec<_>>();
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<h2 id="troubleshooting"><a class="header" href="#troubleshooting">Troubleshooting</a></h2>
|
||
|
|
<p><strong>Q: "Agent registry is full"</strong>
|
||
|
|
A: Increase capacity: <code>AgentRegistry::new(20)</code></p>
|
||
|
|
<p><strong>Q: "Agent ID already registered"</strong>
|
||
|
|
A: Use unique agent names or generate new IDs</p>
|
||
|
|
<h2 id="next-steps"><a class="header" href="#next-steps">Next Steps</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>Tutorial 3: <a href="03-llm-routing.html">LLM Routing</a></li>
|
||
|
|
<li>Example: <code>crates/vapora-agents/examples/03-agent-selection.rs</code></li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="reference"><a class="header" href="#reference">Reference</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>Source: <code>crates/vapora-agents/src/registry.rs</code></li>
|
||
|
|
<li>API Docs: <code>cargo doc --open -p vapora-agents</code></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../tutorials/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../tutorials/03-llm-routing.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../../tutorials/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../tutorials/03-llm-routing.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script>
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js"></script>
|
||
|
|
<script src="../mark.min.js"></script>
|
||
|
|
<script src="../searcher.js"></script>
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js"></script>
|
||
|
|
<script src="../highlight.js"></script>
|
||
|
|
<script src="../book.js"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|