Skip to main content
Version: Current

Opscotch LLM Skill Overview

Purpose

The Opscotch LLM Skill is a comprehensive, portable knowledge artifact designed to equip an LLM with deep operational knowledge of the Opscotch system. It provides explicit, structured technical knowledge that enables an LLM to effectively work with Opscotch configurations, workflows, and operations.

What's Included

The skill covers:

  • Bootstrap Configuration: Understanding and writing bootstrap files for runtime initialization, deployment settings, licensing, and security controls
  • Workflow Design: Creating, composing, and debugging workflows with steps, triggers, processors, and data flow
  • Runtime Operations: Starting, stopping, and managing the Opscotch runtime environment
  • Packaging: Building, signing, encrypting, and deploying workflow packages
  • Testing: Writing and running tests for workflow validation
  • Administration: Security, licensing, cryptography, and operational best practices

How to Use

The skill file is designed to be dropped into an LLM as a system-level skill or knowledge file. It provides:

  • Explicit field definitions and requirements
  • Schema-backed structural guidance
  • Operational procedures and examples
  • Architectural reasoning patterns

File Structure

  • opscotch-llm-skill.md - The complete public skill document
  • opscotch-architect-skill.md - A complementary design-focused skill for architectural thinking
  • /llm/apireference-index.json - The public API reference index for normal workflow execution
  • /llm/apireference.json - The public API reference detail for normal workflow execution
  • /llm/apireference-authenticated-index.json - The public API reference index for authenticated execution
  • /llm/apireference-authenticated.json - The public API reference detail for authenticated execution

API Corpus Assets

The split API reference JSON artifacts are published as static assets so they can be fetched directly from the website:

Schema Files

JSON schema files define the structure and validation rules for Opscotch configuration files. These schemas provide explicit field definitions and requirements for configuration authoring:

  • Bootstrap schema - Configuration for runtime initialization, deployment settings, licensing, and security controls
  • Workflow schema - Structure for workflow definitions including steps, triggers, processors, and data flow
  • Test Runner schema - Configuration for test execution and validation
  • Context schema - Context data structure for runtime operations