nika 0.35.4

Semantic YAML workflow engine for AI tasks - DAG execution, MCP integration, multi-provider LLM support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
//! Tier 3: Agent + File Tools Workflows (08-09)
//!
//! Prerequisites: LLM provider configured
//!
//! Features covered:
//! - agent: Multi-turn agentic loop with tools
//! - File tools: nika:read, nika:write, nika:edit, nika:glob, nika:grep
//! - completion: Agent completion configuration
//! - output: JSON Schema validation
//! - artifact: File persistence

use super::WorkflowTemplate;

pub const TIER3_DIR: &str = "tier-3-agent";

// =============================================================================
// WORKFLOW 08: Agent Basics
// =============================================================================
pub const WORKFLOW_08_AGENT_BASIC: &str = r##"# ╔═══════════════════════════════════════════════════════════════════════════════╗
# ║  🐔 WORKFLOW 08: AGENT BASICS                                                 ║
# ║  Multi-turn agents with file tools and stop conditions                        ║
# ╠═══════════════════════════════════════════════════════════════════════════════╣
# ║                                                                               ║
# ║  AGENT ARCHITECTURE:                                                          ║
# ║  ┌────────────────────────────────────────────────────────────────────────┐   ║
# ║  │                                                                        │   ║
# ║  │   🐔 AGENT LOOP (multi-turn)                                           │   ║
# ║  │   ┌──────────────────────────────────────────────────────────────┐    │   ║
# ║  │   │                                                              │    │   ║
# ║  │   │   Turn 1: "Let me read the project files..."               │    │   ║
# ║  │   │           ├─► nika:glob (find files)                        │    │   ║
# ║  │   │           └─► nika:read (read content)                      │    │   ║
# ║  │   │                                                              │    │   ║
# ║  │   │   Turn 2: "I found 3 files. Analyzing..."                   │    │   ║
# ║  │   │           └─► (LLM reasoning)                                │    │   ║
# ║  │   │                                                              │    │   ║
# ║  │   │   Turn 3: "Writing summary..."                              │    │   ║
# ║  │   │           └─► nika:write (create file)                      │    │   ║
# ║  │   │                                                              │    │   ║
# ║  │   │   Turn 4: "TASK_COMPLETE: Summary written"                  │    │   ║
# ║  │   │           └─► (stop condition triggered)                     │    │   ║
# ║  │   │                                                              │    │   ║
# ║  │   └──────────────────────────────────────────────────────────────┘    │   ║
# ║  │                                                                        │   ║
# ║  └────────────────────────────────────────────────────────────────────────┘   ║
# ║                                                                               ║
# ║  AVAILABLE TOOLS (5 file tools):                                              ║
# ║  ┌──────────────┬─────────────────────────────────────────────────────────┐   ║
# ║  │ nika:read    │ Read file contents                                      │   ║
# ║  │ nika:write   │ Create or overwrite file                                │   ║
# ║  │ nika:edit    │ Replace text in file                                    │   ║
# ║  │ nika:glob    │ Find files by pattern                                   │   ║
# ║  │ nika:grep    │ Search file contents                                    │   ║
# ║  └──────────────┴─────────────────────────────────────────────────────────┘   ║
# ║                                                                               ║
# ║  STOP CONDITIONS (automatic termination):                                     ║
# ║  • max_turns: Maximum iterations before forced stop                          ║
# ║  • stop_phrases: Text patterns that trigger graceful stop                    ║
# ║  • timeout: Maximum wall-clock time (future)                                 ║
# ║                                                                               ║
# ╚═══════════════════════════════════════════════════════════════════════════════╝

schema: nika/workflow@0.12
workflow: agent-file-explorer

# ─────────────────────────────────────────────────────────────────────────────────
# 📝 SCENARIO
# ─────────────────────────────────────────────────────────────────────────────────
# An agent that explores a directory, analyzes its contents,
# and writes a summary report. Demonstrates multi-turn tool use.

tasks:
  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 1: Setup - Create some sample files for the agent to explore
  # ═══════════════════════════════════════════════════════════════════════════════

  - id: setup_files
    exec:
      command: |
        mkdir -p ./agent-demo && \
        echo '# Project Alpha\n\nA demo project for testing.' > ./agent-demo/README.md && \
        echo '{"name": "alpha", "version": "1.0.0"}' > ./agent-demo/package.json && \
        echo 'def hello(): return "Hello from Python"' > ./agent-demo/main.py
      shell: true

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 2: Agent - Explore and Analyze
  # ═══════════════════════════════════════════════════════════════════════════════
  # The agent autonomously decides what tools to use

  - id: explore_agent
    depends_on: [setup_files]
    agent:
      prompt: |
        You are a code analysis agent. Your task is to:

        1. Explore the ./agent-demo directory
        2. Read each file you find
        3. Analyze the project structure
        4. Write a summary report to ./agent-demo/ANALYSIS.md

        Use the available tools to accomplish this task.
        When you're done, include "TASK_COMPLETE" in your response.

      # ─────────────────────────────────────────────────────────────────────────
      # 🛠️ TOOLS: What the agent can use
      # ─────────────────────────────────────────────────────────────────────────
      tools: [builtin]

      # ─────────────────────────────────────────────────────────────────────────
      # ⚙️ AGENT CONFIGURATION
      # ─────────────────────────────────────────────────────────────────────────
      max_turns: 10                    # Maximum conversation turns
      temperature: 0.3                 # Lower = more focused

      # ─────────────────────────────────────────────────────────────────────────
      # 🧠 SYSTEM PROMPT
      # ─────────────────────────────────────────────────────────────────────────
      system: |
        You are a meticulous code analyst.

        CRITICAL: You ONLY have access to these tools:
        - nika:glob - Find files by pattern
        - nika:read - Read file contents
        - nika:write - Create or overwrite files

        DO NOT attempt to use any other tools. If you need functionality
        not provided by these tools, state what you would need and continue
        with what you have.

        Process:
        1. Use nika:glob to find files in the directory
        2. Use nika:read to read each file's content
        3. Analyze the project structure
        4. Use nika:write to create the ANALYSIS.md file
        5. End with TASK_COMPLETE when done

    # ─────────────────────────────────────────────────────────────────────────
    # 📐 OUTPUT SCHEMA - Validates final agent response
    # ─────────────────────────────────────────────────────────────────────────
    output:
      schema:
        type: object
        required:
          - status
          - summary
        properties:
          status:
            type: string
            enum: [TASK_COMPLETE, ANALYSIS COMPLETE, FAILED]
          summary:
            type: string
            description: "Brief description of what was analyzed"
          files_found:
            type: array
            items:
              type: string

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 3: Verify Output
  # ═══════════════════════════════════════════════════════════════════════════════

  - id: verify_output
    depends_on: [explore_agent]
    with:
      agent_result: $explore_agent
    exec:
      command: "cat ./agent-demo/ANALYSIS.md 2>/dev/null || echo 'No analysis file found'"
      shell: true

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 4: Cleanup
  # ═══════════════════════════════════════════════════════════════════════════════

  - id: cleanup
    depends_on: [verify_output]
    with:
      verification: $verify_output
    exec:
      command: "rm -rf ./agent-demo"
      shell: true

# ═══════════════════════════════════════════════════════════════════════════════
# 🎓 AGENT REFERENCE
# ═══════════════════════════════════════════════════════════════════════════════
#
# AGENT SYNTAX:
# ┌────────────────────────────────────────────────────────────────────────────┐
# │ - id: my_agent                                                             │
# │   depends_on: [previous_task]                                              │
# │   agent:                                                                    │
# │     prompt: "Your task..."        # What the agent should do              │
# │     tools: [builtin]              # All builtin tools                     │
# │     max_turns: 10                  # Max iterations                        │
# │     temperature: 0.5               # Creativity level                      │
# │     system: "You are..."           # Persona/role                          │
# └────────────────────────────────────────────────────────────────────────────┘
#
# FILE TOOLS REFERENCE:
# ┌──────────────┬─────────────────────────────────────────────────────────────┐
# │ Tool         │ Parameters                                                   │
# ├──────────────┼─────────────────────────────────────────────────────────────┤
# │ nika:read    │ { "file_path": "./file.txt" }                               │
# │ nika:write   │ { "file_path": "./out.txt", "content": "..." }              │
# │ nika:edit    │ { "file_path": "./f.txt", "old": "x", "new": "y" }          │
# │ nika:glob    │ { "pattern": "**/*.rs", "path": "./" }                      │
# │ nika:grep    │ { "pattern": "TODO", "path": "./src" }                      │
# └──────────────┴─────────────────────────────────────────────────────────────┘
#
# AGENT vs INFER:
# ┌────────────┬──────────────────────────────────────────────────────────────┐
# │            │ infer:              │ agent:                                 │
# ├────────────┼─────────────────────┼────────────────────────────────────────┤
# │ Turns      │ Single              │ Multi-turn (up to max_turns)           │
# │ Tools      │ None                │ Can use tools autonomously             │
# │ Autonomy   │ Direct answer       │ Decides own approach                   │
# │ Best for   │ Simple generation   │ Complex, multi-step tasks              │
# └────────────┴─────────────────────┴────────────────────────────────────────┘
#
# RUN THIS WORKFLOW:
# nika run workflows/tier-3-agent/08-agent-basic.nika.yaml
"##;

// =============================================================================
// WORKFLOW 09: Structured Output + Artifacts
// =============================================================================
pub const WORKFLOW_09_STRUCTURED_OUTPUT: &str = r##"# ╔═══════════════════════════════════════════════════════════════════════════════╗
# ║  📐 WORKFLOW 09: STRUCTURED OUTPUT + ARTIFACTS                                ║
# ║  JSON Schema validation and file persistence                                  ║
# ╠═══════════════════════════════════════════════════════════════════════════════╣
# ║                                                                               ║
# ║  STRUCTURED OUTPUT FLOW:                                                      ║
# ║  ┌────────────────────────────────────────────────────────────────────────┐   ║
# ║  │                                                                        │   ║
# ║  │   ┌─────────────┐    ┌─────────────┐    ┌─────────────┐               │   ║
# ║  │   │   INPUT     │───►│    LLM      │───►│  VALIDATE   │               │   ║
# ║  │   │   PROMPT    │    │  GENERATE   │    │   SCHEMA    │               │   ║
# ║  │   └─────────────┘    └─────────────┘    └──────┬──────┘               │   ║
# ║  │                                                │                       │   ║
# ║  │                           ┌────────────────────┴────────────────────┐  │   ║
# ║  │                           │                                         │  │   ║
# ║  │                           ▼                                         ▼  │   ║
# ║  │                    ┌─────────────┐                          ┌──────────┴┐ ║
# ║  │                    │   ✅ VALID  │                          │ ❌ RETRY  │ ║
# ║  │                    │   OUTPUT    │                          │ (3 tries) │ ║
# ║  │                    └──────┬──────┘                          └───────────┘ ║
# ║  │                           │                                               │   ║
# ║  │                           ▼                                               │   ║
# ║  │                    ┌─────────────┐                                       │   ║
# ║  │                    │  ARTIFACT   │                                       │   ║
# ║  │                    │  (persist)  │                                       │   ║
# ║  │                    └─────────────┘                                       │   ║
# ║  │                                                                        │   ║
# ║  └────────────────────────────────────────────────────────────────────────┘   ║
# ║                                                                               ║
# ║  JSON SCHEMA VALIDATION:                                                      ║
# ║  • Enforces specific structure on LLM output                                  ║
# ║  • Auto-retry on validation failure (up to 3 times)                           ║
# ║  • Injects schema into prompt for better compliance                           ║
# ║                                                                               ║
# ║  ARTIFACTS:                                                                   ║
# ║  • Persist task outputs to files                                              ║
# ║  • Template variables: {{task_id}}, {{date}}, {{timestamp}}                   ║
# ║  • Atomic writes (crash-safe)                                                 ║
# ║                                                                               ║
# ╚═══════════════════════════════════════════════════════════════════════════════╝

schema: nika/workflow@0.12
workflow: structured-output-artifacts

# ─────────────────────────────────────────────────────────────────────────────────
# 📁 ARTIFACTS CONFIG - Set base directory for artifact outputs
# ─────────────────────────────────────────────────────────────────────────────────
# All artifact paths are relative to this directory.
artifacts:
  dir: ./output
  format: json
  mode: overwrite

tasks:
  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 1: Generate Product Data with Schema Validation
  # ═══════════════════════════════════════════════════════════════════════════════
  # The LLM MUST output JSON matching this exact schema

  - id: generate_product
    infer:
      prompt: |
        Generate a product listing for a futuristic smart home device.
        Be creative with the features and pricing.
      temperature: 0.7
      max_tokens: 500

    # ─────────────────────────────────────────────────────────────────────────────
    # 📐 OUTPUT SCHEMA - JSON Schema validation
    # ─────────────────────────────────────────────────────────────────────────────
    # The LLM output MUST match this schema. If not, Nika retries up to 3 times.

    output:
      schema:
        type: object
        required:
          - name
          - tagline
          - price
          - features
          - specifications
        properties:
          name:
            type: string
            description: "Product name (2-4 words)"
            minLength: 3
            maxLength: 50
          tagline:
            type: string
            description: "Marketing tagline (catchy, <100 chars)"
            maxLength: 100
          price:
            type: object
            required: [amount, currency]
            properties:
              amount:
                type: number
                minimum: 0
              currency:
                type: string
                enum: [USD, EUR, GBP, JPY]
          features:
            type: array
            description: "Key product features"
            minItems: 3
            maxItems: 6
            items:
              type: object
              required: [title, description]
              properties:
                title:
                  type: string
                description:
                  type: string
          specifications:
            type: object
            properties:
              dimensions:
                type: string
              weight:
                type: string
              connectivity:
                type: array
                items:
                  type: string
              power:
                type: string

    # ─────────────────────────────────────────────────────────────────────────────
    # 💾 ARTIFACT - Save output to file
    # ─────────────────────────────────────────────────────────────────────────────
    # The validated output is persisted to a file.

    artifact:
      path: products/{{task_id}}_{{date}}.json
      format: json

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 2: Generate Marketing Content with Different Schema
  # ═══════════════════════════════════════════════════════════════════════════════

  - id: generate_marketing
    depends_on: [generate_product]
    with:
      product: $generate_product
    infer:
      prompt: |
        Create marketing content for this product:

        {{with.product}}

        Generate social media posts for different platforms.
      temperature: 0.6
      max_tokens: 600

    output:
      schema:
        type: object
        required: [twitter, linkedin, instagram]
        properties:
          twitter:
            type: object
            required: [post, hashtags]
            properties:
              post:
                type: string
                maxLength: 280
              hashtags:
                type: array
                items:
                  type: string
                maxItems: 5
          linkedin:
            type: object
            required: [headline, body]
            properties:
              headline:
                type: string
                maxLength: 100
              body:
                type: string
                minLength: 100
                maxLength: 700
          instagram:
            type: object
            required: [caption, suggested_image]
            properties:
              caption:
                type: string
              suggested_image:
                type: string
                description: "Description for AI image generation"

    artifact:
      path: marketing/{{task_id}}_{{date}}.json
      format: json

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 3: Agent with Structured Output
  # ═══════════════════════════════════════════════════════════════════════════════
  # Even agents can have structured output requirements

  - id: analyze_agent
    depends_on: [generate_product, generate_marketing]
    with:
      product: $generate_product
      marketing: $generate_marketing
    agent:
      prompt: |
        Analyze the product and marketing content:

        PRODUCT:
        {{with.product}}

        MARKETING:
        {{with.marketing}}

        Your analysis should:
        1. Check message consistency across platforms
        2. Identify potential improvements
        3. Rate the overall marketing quality

        Use the file tools if needed to research competitors.
      tools: [builtin]
      max_turns: 5
      temperature: 0.4
    # Agent output also validated against schema
    output:
      schema:
        type: object
        required: [consistency_score, improvements, overall_rating]
        properties:
          consistency_score:
            type: number
            minimum: 0
            maximum: 100
            description: "Message consistency across platforms (0-100)"
          improvements:
            type: array
            items:
              type: object
              required: [platform, suggestion]
              properties:
                platform:
                  type: string
                  enum: [twitter, linkedin, instagram, general]
                suggestion:
                  type: string
          overall_rating:
            type: object
            required: [score, summary]
            properties:
              score:
                type: number
                minimum: 1
                maximum: 10
              summary:
                type: string
                maxLength: 200

    artifact:
      path: analysis/{{task_id}}_{{timestamp}}.json
      format: json

  # ═══════════════════════════════════════════════════════════════════════════════
  # TASK 4: Combine and Export Final Report
  # ═══════════════════════════════════════════════════════════════════════════════

  - id: final_report
    depends_on: [generate_product, generate_marketing, analyze_agent]
    with:
      product: $generate_product
      marketing: $generate_marketing
      analysis: $analyze_agent
    infer:
      prompt: |
        Create a final executive summary combining all our work:

        PRODUCT DATA:
        {{with.product}}

        MARKETING CONTENT:
        {{with.marketing}}

        QUALITY ANALYSIS:
        {{with.analysis}}

        Summarize everything in a brief executive report.
      temperature: 0.3
      max_tokens: 400

    artifact:
      path: reports/executive_summary_{{date}}.txt
      format: text

# ═══════════════════════════════════════════════════════════════════════════════
# 🎓 STRUCTURED OUTPUT REFERENCE
# ═══════════════════════════════════════════════════════════════════════════════
#
# OUTPUT SCHEMA SYNTAX:
# ┌────────────────────────────────────────────────────────────────────────────┐
# │ output:                                                                    │
# │   schema:                          # JSON Schema definition               │
# │     type: object                                                          │
# │     required: [field1, field2]     # Required fields                      │
# │     properties:                                                           │
# │       field1:                                                             │
# │         type: string               # string, number, boolean, array, obj  │
# │         minLength: 1                                                      │
# │         maxLength: 100                                                    │
# │       field2:                                                             │
# │         type: number                                                      │
# │         minimum: 0                                                        │
# │         maximum: 100                                                      │
# │       field3:                                                             │
# │         type: array                                                       │
# │         items:                                                            │
# │           type: string                                                    │
# │         minItems: 1                                                       │
# │         maxItems: 10                                                      │
# │       field4:                                                             │
# │         type: string                                                      │
# │         enum: [option1, option2]   # Allowed values                       │
# └────────────────────────────────────────────────────────────────────────────┘
#
# ARTIFACT SYNTAX:
# ┌────────────────────────────────────────────────────────────────────────────┐
# │ artifact:                                                                  │
# │   path: {{task_id}}_{{date}}.json             # File path with templates   │
# │   format: json                                # json, yaml, or text         │
# └────────────────────────────────────────────────────────────────────────────┘
#
# TEMPLATE VARIABLES:
# ┌─────────────────┬──────────────────────────────────────────────────────────┐
# │ {{task_id}}     │ The task's id (e.g., "generate_product")                │
# │ {{date}}        │ Current date (YYYY-MM-DD)                               │
# │ {{timestamp}}   │ Unix timestamp                                          │
# │ {{workflow}}    │ Workflow name                                           │
# │ {{run_id}}      │ Unique run identifier                                   │
# └─────────────────┴──────────────────────────────────────────────────────────┘
#
# VALIDATION BEHAVIOR:
# ┌────────────────────────────────────────────────────────────────────────────┐
# │ 1. LLM generates output                                                   │
# │ 2. Nika validates against schema                                          │
# │ 3. If invalid → retry with error feedback (up to 3 times)                │
# │ 4. If still invalid → task fails with NIKA-060/061 error                 │
# │ 5. If valid → save artifact (if configured)                               │
# └────────────────────────────────────────────────────────────────────────────┘
#
# SETUP:
# mkdir -p ./output/products ./output/marketing ./output/analysis ./output/reports
#
# RUN THIS WORKFLOW:
# nika run workflows/tier-3-agent/09-structured-output.nika.yaml
"##;

/// Returns all Tier 3 workflows (08-09)
pub fn get_tier3_workflows() -> Vec<WorkflowTemplate> {
    vec![
        WorkflowTemplate {
            filename: "08-agent-basic.nika.yaml",
            tier_dir: TIER3_DIR,
            content: WORKFLOW_08_AGENT_BASIC,
        },
        WorkflowTemplate {
            filename: "09-structured-output.nika.yaml",
            tier_dir: TIER3_DIR,
            content: WORKFLOW_09_STRUCTURED_OUTPUT,
        },
    ]
}