Quick Start Patterns#

What You’ll Learn

Essential Development Skills:

  • Building production-ready capabilities with @capability_node decorator patterns

  • Working with AgentState, StateManager, and ContextManager for data flow

  • Creating type-safe Pydantic context classes for component communication

  • Testing and debugging workflows using Gateway architecture

  • Registry-based component discovery and framework integration

  • Generating capabilities from MCP servers (prototype feature)

  • Implementing custom physics simulation backends for soft IOCs

Prerequisites: Python development experience and basic framework understanding

Target Audience: Developers building their first agentic system capabilities

Get productive immediately with the Osprey Framework’s essential development patterns. Each guide focuses on specific skills you need to build effective agent capabilities.

🖥️ CLI Reference

Start here - Essential commands

Complete reference for framework init, config, deploy, and chat. Learn project creation, configuration management, and deployment workflows.

10 minutes

CLI Reference
🏗️ Build Your First Capability

Hands-on development

Step-by-step implementation of BaseCapability with @capability_node decorator and framework integration.

30-45 minutes

Building Your First Capability
🔄 State and Context Essentials

Master data management patterns

AgentState, StateManager utilities, ContextManager, and type-safe data exchange between capabilities.

15-20 minutes

State and Context Essentials
🧪 Running and Testing

Test and deploy your work

Gateway architecture, CLI interface, debugging workflows, and production deployment patterns.

15-20 minutes

Running and Testing
🔌 MCP Capability Generation

Generate from MCP servers (Prototype)

Auto-generate capabilities from Model Context Protocol servers with ReAct agent patterns.

20-30 minutes

MCP Capability Generation
🎛️ Soft IOC Custom Backends

Physics simulation backends

Implement custom simulation backends for soft IOCs using SimulationBackend and OverlayProtocol.

20-30 minutes

Soft IOC Custom Backends

Recommended order: CLI Reference → Build → State → Testing → MCP Generation (optional). Start with CLI commands, then dive into development patterns.

🚀 Next Steps

After mastering these patterns, explore advanced framework topics: