| SDK Architecture | Covers the SDK’s two phases — design-time configuration and runtime execution — and its two components: the agentic-core library (design-time builder models, runtime abstract classes, and the MCP server) and the workspace (project scaffold with the run.py CLI). Also details memory store configuration with scope and retention options, structured tool logging, and the full deployment sequence from packaging a KAR archive to container provisioning. |
| CLI Reference | Documents all eight run.py commands — config, package, start, deploy, publish, status, undeploy, and test — with full syntax, options, and examples for each. Includes environment configuration for dev, staging, and production environments, a complete lifecycle workflow from local development to production deployment, and troubleshooting guidance for common issues. |
| API Reference | Reference for design-time builder classes (App, Agent, Tool, LlmModel, MemoryStore, EnvVariable, Prompt, Icon) and runtime service APIs (RequestContext, Logger, Tracer), with constructor parameters and method signatures. Covers accessing session context and environment variables, performing memory CRUD operations with field projections, emitting structured logs at four severity levels, and integrating distributed tracing into tools and orchestrators. |
| Examples | Walks through two complete applications: a single-agent banking assistant with custom MCP tools for balance checks and fund transfers, a session-scoped memory store, and a keyword-routing orchestrator; and a multi-agent customer service app with three specialized agents (support, billing, technical) that routes requests by intent and escalates between agents. Both examples include full implementation code, project structure, and CLI commands to package, deploy, and test end to end. |
| Build Applications | Covers end-to-end app assembly: defining App, configuring agents (LLM + prompts), registering tools, setting up memory stores, configuring advanced features, implementing a custom orchestrator, and starting the MCP server. Includes a complete example and best practices. |
| Create Agents | Explains agent configuration in depth: autonomous vs proxy types, REACT pattern, roles (WORKER/SUPERVISOR), prompt design, LLM settings, tool attachment (builder and direct), metadata, icons, real-time flags, and conversion to AgentMeta for orchestration. |
| Work with Tools | Details tool creation and usage: MCP tools via @Tool.register, inline tools, tool library, and knowledge tools. Covers request context access, memory operations inside tools, structured logging, tracing, agent integration, and best practices for error handling and performance. |
| Memory Stores | Describes design-time memory configuration (schema, namespaces, scope, retention), adding stores to apps, and runtime CRUD operations (set_content, get_content, delete_content). Explains scope types, retention policies, projections, schema validation, security, and performance guidance. |
| Prompts and LLM Config | Covers LLM model setup across providers (OpenAI, Anthropic, Azure), parameter tuning (temperature, tokens, top_p, penalties), builder patterns, structured prompt design, template variables, supervisor prompts, security rules, and optimization strategies for cost and quality. |
| Custom Orchestration | Explains implementing AbstractOrchestrator, message handling protocol (user/tool roles), ToolCall and route_to_user, routing strategies (keyword, round-robin, task-based), stateful orchestration with memory, tracing integration, and common multi-agent flow patterns. |