How-To Guides#
Task-oriented guides that walk you through common OSPREY operations step by step. Each guide focuses on a single goal and assumes you already have a working OSPREY installation.
Framework & Infrastructure#
Set up and switch between supported LLM providers — Anthropic, OpenAI, Google,
CBORG, AMSC i2, Ollama, and others — via config.yml.
Drive the Osprey agent with open-weight or self-hosted models via the
translation proxy, and benchmark their capability with scripts/benchmark/.
Create, configure, and deploy an OSPREY project from osprey build through
osprey deploy to a running instance.
Build and run the container image generated for every project — build args, path relocation, air-gapped mode, and Kubernetes notes.
Assemble facility-specific assistants from templates with config overrides, file overlays, and custom MCP servers.
Build and register a new FastMCP server to expose domain-specific tools that the Osprey agent can discover and call.
Launch and operate the Web Terminal interface for interactive Osprey agent sessions with your control system.
Run the Osprey agent in your native terminal with companion services accessible in a browser.
Run the OSPREY agent headlessly from CI pipelines and automated workflows
with osprey query — read-only, structured JSON output, and clear exit codes.
Run agent-generated Python scripts safely in a containerized environment with access to the OSPREY runtime API.
Turn external events — webhooks and cron ticks — into headless Osprey agent runs, deployed as containers or run locally.
Complete reference for all osprey commands — build, deploy, config,
health, claude, web, and more.
Services & Connectors#
Create a custom connector to integrate a new control system protocol (beyond EPICS and Mock) with OSPREY’s protocol-agnostic architecture.
Search, filter, and explore control system channels using the Channel Finder service and its web interface.
Intelligent search over facility electronic logbooks with keyword and semantic retrieval modes, plus multi-step reasoning delegated to the Osprey agent.
Author and serve structured facility knowledge (subsystems, devices, procedures) to the OSPREY agent via an on-demand markdown bundle.