@bluefly/openstandardagents 0.5.1 → 0.5.4

package/examples/openai/swarm-agent.ossa.json

@@ -1,72 +0,0 @@
-{
-  "apiVersion": "ossa/v0.4.1",
-  "kind": "Agent",
-  "metadata": {
-    "name": "swarm-agent",
-    "version": "1.0.0",
-    "description": "OpenAI Agents SDK swarm agent"
-  },
-  "spec": {
-    "role": "You are a helpful AI assistant that can coordinate with other agents to solve complex tasks.",
-    "llm": {
-      "provider": "openai",
-      "model": "gpt-4o",
-      "temperature": 0.7
-    },
-    "tools": [
-      {
-        "type": "function",
-        "name": "search_web",
-        "capabilities": [
-          {
-            "name": "search"
-          },
-          {
-            "name": "retrieve"
-          }
-        ]
-      },
-      {
-        "type": "function",
-        "name": "execute_code",
-        "capabilities": [
-          {
-            "name": "run"
-          },
-          {
-            "name": "evaluate"
-          }
-        ]
-      }
-    ]
-  },
-  "extensions": {
-    "openai_agents": {
-      "enabled": true,
-      "model": "gpt-4o",
-      "instructions": "You are a helpful AI assistant that can coordinate with other agents to solve complex tasks.",
-      "tools_mapping": [
-        {
-          "ossa_capability": "search_web",
-          "openai_tool_name": "web_search",
-          "description": "Search the web for information"
-        },
-        {
-          "ossa_capability": "execute_code",
-          "openai_tool_name": "code_executor",
-          "description": "Execute Python code safely"
-        }
-      ],
-      "guardrails": {
-        "enabled": true,
-        "max_tool_calls": 10,
-        "timeout_seconds": 300
-      },
-      "memory": {
-        "enabled": true,
-        "type": "session",
-        "max_messages": 50
-      }
-    }
-  }
-}

package/examples/openapi-extensions/README.md

@@ -1,87 +0,0 @@
-# OSSA OpenAPI Extensions Examples
-
-This directory contains example OpenAPI 3.1 specifications demonstrating OSSA extensions for AI agents.
-
-## Examples
-
-### minimal-agent-api.openapi.yml
-
-**Purpose**: Minimal example showing basic OSSA extensions
-
-**Features Demonstrated**:
-- Root-level `x-ossa-metadata` extension
-- Root-level `x-ossa` extension with agent identification
-- Operation-level `x-ossa-capability` extension
-- Operation-level `x-ossa-autonomy` extension
-- Operation-level `x-ossa-llm` extension
-
-**Use Case**: Simple greeting agent that demonstrates the basics of OSSA extensions without complexity.
-
-### worker-agent-api.openapi.yml
-
-**Purpose**: Complete worker agent API showing all OSSA extensions
-
-**Features Demonstrated**:
-- Full `x-ossa-metadata` with governance and compliance
-- Complete `x-ossa` and `x-agent` root extensions
-- All operation-level extensions (capability, autonomy, constraints, tools, llm)
-- Parameter extensions (`X-OSSA-Agent-ID`, `X-OSSA-Version`)
-- Schema extensions (`x-ossa-capability-schema`)
-- Real-world example: Kubernetes troubleshooting agent
-
-**Use Case**: Production-ready worker agent that diagnoses Kubernetes pod issues using MCP tools.
-
-### orchestrator-agent-api.openapi.yml
-
-**Purpose**: Multi-agent orchestration example
-
-**Features Demonstrated**:
-- Orchestrator agent type
-- Multi-agent coordination capabilities
-- Complex workflow execution with task delegation
-- Higher-level constraints for orchestrator operations
-- Multiple MCP tool integrations (agent-router, agent-mesh, workflow-engine)
-
-**Use Case**: Orchestrator that coordinates multiple worker agents to execute complex workflows.
-
-## Running Examples
-
-### Validate Examples
-
-```bash
-# Validate a specific example
-ossa validate --openapi examples/openapi-extensions/minimal-agent-api.openapi.yml
-
-# Validate all examples
-find examples/openapi-extensions -name "*.openapi.yml" -exec ossa validate --openapi {} \;
-```
-
-### Using with OpenAPI Tools
-
-All examples are valid OpenAPI 3.1 specs and work with standard OpenAPI tools:
-
-```bash
-# Generate documentation with Redoc
-npx @redocly/cli build-docs examples/openapi-extensions/worker-agent-api.openapi.yml
-
-# Generate client with openapi-generator
-npx @openapitools/openapi-generator-cli generate \
-  -i examples/openapi-extensions/worker-agent-api.openapi.yml \
-  -g typescript-axios \
-  -o ./generated-client
-```
-
-### Viewing Examples
-
-Use any OpenAPI viewer:
-- [Swagger Editor](https://editor.swagger.io/) - Paste YAML content
-- [Swagger UI](https://swagger.io/tools/swagger-ui/) - Host locally
-- [Stoplight Studio](https://stoplight.io/studio) - Desktop app
-
-## Documentation
-
-For complete documentation on OSSA OpenAPI extensions, see:
-- [OpenAPI Extensions Documentation](../../docs/openapi-extensions.md)
-- [OSSA Specification](../../spec/v0.2.2/OSSA-SPECIFICATION-v0.2.2.md)
-- [GitHub Repository](https://github.com/blueflyio/openstandardagents)
-

package/examples/openapi-extensions/minimal-agent-api.openapi.yml

@@ -1,288 +0,0 @@
-# ============================================================================
-# OSSA OpenAPI Extensions Example: Minimal Agent API
-# ============================================================================
-#
-# PURPOSE:
-#   Demonstrates the minimal OpenAPI 3.1 specification with OSSA extensions
-#   for defining agent APIs. Shows how to add OSSA metadata to standard
-#   OpenAPI specs for agent discovery, validation, and lifecycle management.
-#
-# KEY CONCEPTS:
-#   - OpenAPI 3.1 as the base specification (JSON Schema compatible)
-#   - OSSA extensions via x-ossa-* fields (vendor extensions)
-#   - Agent capabilities mapped to OpenAPI operations
-#   - Type-safe contracts with JSON Schema validation
-#   - LLM configuration at the operation level
-#
-# ARCHITECTURE:
-#   OpenAPI 3.1 Spec
-#     + x-ossa-metadata (document-level OSSA info)
-#     + x-ossa (agent configuration)
-#     + x-ossa-capability (operation-level capability metadata)
-#     + x-ossa-autonomy (operation-level autonomy controls)
-#     + x-ossa-llm (operation-level LLM configuration)
-#     → OSSA-compliant Agent API
-#
-# USE CASE:
-#   Simple greeting agent that generates personalized greetings in multiple
-#   languages using GPT-3.5-turbo. Demonstrates OSSA's OpenAPI-first approach.
-#
-# RELATED DOCUMENTATION:
-#   - OSSA OpenAPI Extensions: spec/OSSA_OpenAPI_Extensions.md
-#   - OpenAPI 3.1 Spec: https://spec.openapis.org/oas/v3.1.0
-#   - Worker Agent Example: examples/openapi-extensions/worker-agent-api.openapi.yml
-# ============================================================================
-
-openapi: 3.1.0
-
-# ============================================================================
-# API Information Block (Standard OpenAPI)
-# ============================================================================
-info:
-  title: Hello World Agent API
-  version: 1.0.0
-  description: |
-    Minimal OSSA-compliant agent API demonstrating basic OpenAPI extensions.
-    This example shows a simple greeting agent with OSSA metadata.
-
-# ============================================================================
-# OSSA Metadata Extension (Document-Level)
-# ============================================================================
-# x-ossa-metadata provides OSSA-specific information about the API document.
-# This is separate from the agent configuration (x-ossa) to allow for
-# governance, compliance, and operational metadata.
-# ============================================================================
-x-ossa-metadata:
-  # OSSA specification version this document conforms to
-  version: 0.2.2
-
-  # Compliance information for governance and audit
-  compliance:
-    level: basic              # basic, intermediate, advanced, enterprise
-    frameworks:
-      - OSSA                  # Open Standard for System Agents
-      - OpenAPI 3.1           # Base specification
-
-# ============================================================================
-# OSSA Agent Configuration Extension
-# ============================================================================
-# x-ossa defines the agent's identity, type, and compliance status.
-# This metadata enables agent registries, discovery, and validation tools.
-# ============================================================================
-x-ossa:
-  # OSSA version (should match x-ossa-metadata.version)
-  version: 0.2.2
-
-  # Agent identity and type
-  agent:
-    # Unique agent identifier (DNS-compatible)
-    id: hello-world-agent
-
-    # Agent type determines execution model:
-    # - "worker": Task-based, stateless execution
-    # - "chat": Interactive, stateful conversation
-    # - "orchestrator": Coordinates other agents
-    # - "integration": Long-running service connector
-    type: worker
-
-    # Compliance tracking for validation pipelines
-    compliance:
-      # Standards this agent implementation adheres to
-      standards:
-        - openapi-first       # API-first design approach
-
-      # Validation status (set by OSSA validators)
-      validated: true
-      validatedAt: "2024-01-15T10:00:00Z"  # ISO 8601 timestamp
-
-# ============================================================================
-# API Paths (Standard OpenAPI with OSSA Extensions)
-# ============================================================================
-paths:
-  # ==========================================================================
-  # /greet - Generate Personalized Greeting
-  # ==========================================================================
-  # Demonstrates OSSA capability mapping to OpenAPI operation.
-  # Each operation represents one agent capability with:
-  # - Standard OpenAPI request/response schemas
-  # - OSSA capability metadata (x-ossa-capability)
-  # - Autonomy controls (x-ossa-autonomy)
-  # - LLM configuration (x-ossa-llm)
-  # ==========================================================================
-  /greet:
-    post:
-      # Standard OpenAPI operation metadata
-      summary: Generate greeting
-      description: Generates a personalized greeting using LLM
-
-      # Unique operation identifier (used for code generation)
-      operationId: greet
-
-      # Tags for grouping operations in documentation
-      tags:
-        - Greeting
-
-      # ======================================================================
-      # OSSA Capability Extension
-      # ======================================================================
-      # Maps this OpenAPI operation to an OSSA agent capability.
-      # Capability name must match agent manifest capability IDs.
-      # ======================================================================
-      x-ossa-capability: greeting
-
-      # ======================================================================
-      # OSSA Autonomy Extension
-      # ======================================================================
-      # Defines autonomy level and approval requirements for this operation.
-      # Controls how much freedom the agent has when executing this capability.
-      # ======================================================================
-      x-ossa-autonomy:
-        # Autonomy levels:
-        # - "autonomous": Agent can execute without human approval
-        # - "supervised": Human must approve before execution
-        # - "collaborative": Human and agent work together
-        level: autonomous
-
-        # Whether approval is required (overrides level if true)
-        approval_required: false
-
-      # ======================================================================
-      # OSSA LLM Extension
-      # ======================================================================
-      # Specifies which LLM to use for this specific operation.
-      # Allows per-operation model selection for cost/performance optimization.
-      # ======================================================================
-      x-ossa-llm:
-        provider: openai             # LLM provider (openai, anthropic, etc.)
-        model: gpt-3.5-turbo         # Model identifier (fast, low-cost)
-        temperature: 0.7             # Creativity level (0.0-1.0)
-
-      # Standard OpenAPI request body definition
-      requestBody:
-        required: true
-        content:
-          # JSON content type (most common for agent APIs)
-          application/json:
-            # JSON Schema for request validation
-            schema:
-              type: object
-
-              # Required fields (validated before execution)
-              required:
-                - name
-
-              properties:
-                # Person's name to include in greeting
-                name:
-                  type: string
-                  description: Name to greet
-                  example: "Alice"
-
-                # Target language for greeting (enum constraint)
-                language:
-                  type: string
-                  enum:
-                    - en    # English
-                    - es    # Spanish
-                    - fr    # French
-                    - de    # German
-                  default: en
-                  description: Language for greeting
-
-      # Response definitions (standard OpenAPI)
-      responses:
-        # Success response (200 OK)
-        '200':
-          description: Greeting generated successfully
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  # Generated greeting text
-                  message:
-                    type: string
-                    description: The greeting message
-                    example: "Hello, Alice! Welcome to OSSA."
-
-                  # Timestamp for audit trail
-                  timestamp:
-                    type: string
-                    format: date-time
-                    description: When the greeting was generated
-
-  # ==========================================================================
-  # /status - Agent Health Check
-  # ==========================================================================
-  # Standard health check endpoint for monitoring and orchestration.
-  # Does not use LLM, so no x-ossa-llm extension needed.
-  # ==========================================================================
-  /status:
-    get:
-      summary: Get agent status
-      description: Returns the current status of the agent
-      operationId: getStatus
-
-      tags:
-        - Status
-
-      responses:
-        '200':
-          description: Agent status
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  # Current operational status
-                  status:
-                    type: string
-                    enum:
-                      - online        # Agent is operational
-                      - offline       # Agent is not responding
-                      - maintenance   # Agent is in maintenance mode
-                    description: Current agent status
-
-                  # Agent version for deployment tracking
-                  version:
-                    type: string
-                    description: Agent version
-
-                  # Uptime metric for monitoring
-                  uptime:
-                    type: integer
-                    description: Uptime in seconds
-
-# ============================================================================
-# End of Minimal OSSA OpenAPI Example
-# ============================================================================
-#
-# VALIDATION:
-#   # Validate OpenAPI spec
-#   swagger-cli validate minimal-agent-api.openapi.yml
-#
-#   # Validate OSSA extensions
-#   ossa validate minimal-agent-api.openapi.yml
-#
-# CODE GENERATION:
-#   # Generate server stub
-#   openapi-generator generate -i minimal-agent-api.openapi.yml \
-#     -g python-flask -o ./server
-#
-#   # Generate client SDK
-#   openapi-generator generate -i minimal-agent-api.openapi.yml \
-#     -g typescript-axios -o ./client
-#
-# KEY TAKEAWAYS:
-#   1. OSSA extends OpenAPI 3.1 with x-ossa-* vendor extensions
-#   2. Standard OpenAPI tooling still works (validators, generators, docs)
-#   3. OSSA extensions add agent-specific metadata (capabilities, autonomy, LLM)
-#   4. One OpenAPI operation = One agent capability
-#   5. Type-safe contracts with JSON Schema validation
-#
-# RELATED EXAMPLES:
-#   - examples/openapi-extensions/worker-agent-api.openapi.yml (full features)
-#   - examples/drupal/gitlab-ml-recommender.ossa.yaml (YAML manifest format)
-#   - spec/OSSA_OpenAPI_Extensions.md (complete specification)
-# ============================================================================
-