Output Dev Scenario File

作者 growthxaia4f6bd40ab0e無授權條款440 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫今天更新

Create test scenario JSON files for Output SDK workflows. Use when creating test inputs, documenting expected behaviors, or setting up workflow testing.

僅含說明Software DevelopmentAI & Agents
AI 產生的概覽

說明如何為 Output SDK 工作流程建立測試情境 JSON 檔案，並使其符合工作流程的輸入 schema。

功能
說明如何為 Output SDK 工作流程撰寫測試情境 JSON 檔案，涵蓋存放資料夾、snake_case 命名，以及與工作流程 Zod inputSchema 的對應。提供基本、完整、邊界與錯誤情境範例，並說明如何以子資料夾整理及檢查清單。也列出用情境檔案執行工作流程、查詢狀態與結果的 CLI 指令。
適用情境
適用於為新的 Output SDK 工作流程建立測試輸入、記錄使用情境、建立回歸測試，或以特定輸入偵錯工作流程行為時。
執行需求
需要 Output SDK CLI（npx output）才能用情境檔案執行工作流程；可選用 jq 驗證 JSON。僅為說明文件，不含指令碼。

Creating Scenario Files

Overview

This skill documents how to create test scenario JSON files for Output SDK workflows. Scenarios provide predefined inputs for testing workflows during development and validation.

When to Use This Skill

  • Creating test inputs for a new workflow
  • Documenting different use cases
  • Setting up regression tests
  • Debugging workflow behavior with specific inputs

Location Convention

Scenario files are stored INSIDE the workflow folder:

src/workflows/{workflow-name}/├── workflow.ts├── steps.ts├── types.ts└── scenarios/    ├── basic_input.json    ├── complex_input.json    └── edge_case_empty.json

Important: Scenarios are workflow-specific and live inside the workflow folder.

File Naming Convention

Use snake_case for scenario file names:

{description}_input.json

Examples:

  • basic_input.json
  • test_input_solar_panels.json
  • edge_case_empty_content.json
  • complex_with_references.json

Naming patterns:

  • basic_* - Minimal valid input
  • complex_* - Full-featured input with all options
  • edge_case_* - Boundary conditions and edge cases
  • error_* - Inputs expected to produce errors

Basic Structure

A scenario file is a JSON file that matches the workflow's inputSchema:

json
{  "fieldName": "value",  "optionalField": "optional value",  "numericField": 42,  "arrayField": ["item1", "item2"]}

Matching inputSchema

The scenario JSON must match the Zod schema defined in types.ts:

Example Schema (types.ts)

typescript
export const WorkflowInputSchema = z.object({  content: z.string().describe('Text content to process'),  numberOfIdeas: z.number().min(1).max(10).default(1),  colorPalette: z.string().optional(),  aspectRatio: z.enum(['1:1', '16:9', '9:16']).default('1:1'),  referenceUrls: z.array(z.string()).optional()});

Corresponding Scenarios

basic_input.json (minimal required fields)

json
{  "content": "This is sample content for testing the workflow."}

complete_input.json (all fields specified)

json
{  "content": "This is sample content for testing the workflow.",  "numberOfIdeas": 3,  "colorPalette": "blue and green tones",  "aspectRatio": "16:9",  "referenceUrls": [    "https://example.com/image1.jpg",    "https://example.com/image2.jpg"  ]}

Real-World Example

Based on image_infographic_nano workflow:

test_input_solar_panels.json

json
{  "content": "Solar panels work by converting sunlight into electricity through the photovoltaic effect. The process begins when photons from sunlight strike the silicon cells in the panel, knocking electrons loose from their atoms. These free electrons flow through the semiconductor material, creating an electric current. The panels contain multiple layers: a protective glass covering, anti-reflective coating to maximize light absorption, silicon cells (both n-type and p-type layers forming a junction), and a backing material. The DC electricity generated by the panels flows through an inverter, which converts it to AC electricity suitable for home use or feeding back into the power grid. Modern solar panels achieve 15-20% efficiency, meaning they convert that percentage of sunlight into usable electricity. The entire system includes mounting hardware, wiring, inverters, and often battery storage for excess energy.",  "numberOfIdeas": 3,  "aspectRatio": "16:9",  "resolution": "2K",  "numberOfGenerations": 1}

test_input_complex.json

json
{  "content": "Detailed explanation of the topic...",  "numberOfIdeas": 5,  "colorPalette": "warm earth tones with orange accents",  "artDirection": "minimalist corporate style",  "aspectRatio": "1:1",  "resolution": "4K",  "numberOfGenerations": 2,  "referenceImageUrls": [    "https://storage.example.com/style-guide.png"  ],  "storageNamespace": "test/infographics"}

Running Scenarios

Using CLI

bash
# Run with scenario filenpx output workflow run workflowName --input path/to/scenarios/basic_input.json
# Run with inline JSONnpx output workflow run workflowName --input '{"content": "test"}'

Example Commands

bash
# Basic scenarionpx output workflow run contentUtilsImageInfographicNano --input src/workflows/content_utils/image_infographic_nano/scenarios/test_input_solar_panels.json
# Complex scenarionpx output workflow run contentUtilsImageInfographicNano --input src/workflows/content_utils/image_infographic_nano/scenarios/test_input_complex.json

Related Skill: output-workflow-run for detailed CLI usage

Scenario Categories

1. Basic/Happy Path

Minimal valid input to verify the workflow works:

json
{  "content": "Simple test content",  "numberOfIdeas": 1}

2. Complete/Full-Featured

All optional fields populated:

json
{  "content": "Detailed content...",  "numberOfIdeas": 5,  "colorPalette": "custom palette",  "artDirection": "specific style",  "aspectRatio": "16:9",  "resolution": "4K",  "numberOfGenerations": 3,  "referenceImageUrls": ["https://example.com/ref.jpg"],  "storageNamespace": "test/folder"}

3. Edge Cases

Test boundary conditions:

edge_case_min_values.json

json
{  "content": "x",  "numberOfIdeas": 1}

edge_case_max_values.json

json
{  "content": "Very long content string...",  "numberOfIdeas": 10}

4. Error Cases (for validation testing)

error_missing_required.json

json
{  "numberOfIdeas": 3}

Note: Error scenarios won't pass validation but are useful for testing error handling.

Best Practices

1. Document the Purpose

Add a comment field (if supported) or create a companion README:

json
{  "_comment": "Tests workflow with multiple reference images",  "content": "...",  "referenceImageUrls": ["url1", "url2", "url3"]}

2. Use Realistic Data

json
{  "content": "Actual representative content that matches real use cases..."}

Not:

json
{  "content": "test"}

3. Cover All Enum Values

If schema has enums, create scenarios for each:

json
// scenario_aspect_1x1.json{ "aspectRatio": "1:1", ... }
// scenario_aspect_16x9.json{ "aspectRatio": "16:9", ... }
// scenario_aspect_9x16.json{ "aspectRatio": "9:16", ... }

4. Include Optional Field Variations

json
// without_optional_fields.json{ "content": "..." }
// with_all_optional_fields.json{ "content": "...", "colorPalette": "...", "artDirection": "..." }
// with_some_optional_fields.json{ "content": "...", "colorPalette": "..." }

5. Create Regression Test Scenarios

Save inputs from bug reports:

json
// regression_issue_123.json{  "_issue": "https://github.com/org/repo/issues/123",  "content": "Input that caused the bug..."}

Scenario Organization

For workflows with many scenarios, organize into subfolders:

scenarios/├── basic/│   └── minimal_input.json├── complete/│   └── all_options.json├── edge_cases/│   ├── empty_array.json│   └── max_length.json└── regression/    └── issue_123.json

Verification Checklist

  • Scenario file located in scenarios/ folder inside workflow directory
  • File uses .json extension
  • File name uses snake_case
  • JSON is valid and parseable
  • All required fields from inputSchema are present
  • Field types match schema (strings, numbers, arrays, etc.)
  • Enum values are valid options from schema
  • Numbers are within min/max constraints
  • At least one basic scenario exists
  • Workflow runs successfully with the scenario

Testing Scenarios

Validate JSON Syntax

bash
# Check JSON is validcat scenarios/basic_input.json | jq .

Run and Verify

bash
# Run workflow with scenarionpx output workflow run workflowName --input scenarios/basic_input.json
# Check status if asyncnpx output workflow status <workflowId>
# Get resultnpx output workflow result <workflowId>

Related Skills

  • output-dev-types-file - Defining inputSchema that scenarios must match
  • output-dev-folder-structure - Understanding scenarios folder location
  • output-workflow-run - Running workflows with scenario files
  • output-workflow-list - Finding available workflows

來源與署名

來源：growthxai/output位於coding_assistants/claude/plugins/outputai/skills/output-dev-scenario-file提交a4f6bd4

授權條款： 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

更多來自 growthxai/output 的技能

Output Workflow Trace File

growthxai

將本機 Output SDK 工作流追蹤檔案的最終輸出渲染成易讀的 Markdown。

Productivity & Workflow440今天更新

Output Plan Workflow

growthxai

引導代理為新的 Output.ai 工作流程產出一份 Markdown 實作計畫。

AI & Agents440今天更新

Output Meta Post Flight

growthxai

用於 Output SDK 工作流程執行後的驗證清單，涵蓋步驟完成、規範遵循、品質與交付項目驗證。

AI & Agents440今天更新

Output Dev Types File

growthxai

說明如何為 Output SDK 工作流程撰寫內含 Zod 結構定義的 types.ts 檔案。

Software Development440今天更新

Output Dev Step Function

growthxai

說明如何在 Output SDK 工作流程的 steps.ts 中撰寫步驟函式，涵蓋 I/O、HTTP、LLM 呼叫與錯誤處理。

Software Development440今天更新

Output Dev Llm Streaming

growthxai

指導在 Output 工作流程步驟中實作 LLM 文字串流，涵蓋串流 API、回呼與錯誤處理。

Software Development440今天更新

更多Software Development技能

Playground

anthropics

精選

建立自成一體的互動式 HTML 遊樂場，包含控制項、即時預覽與可複製的提示詞輸出。

Software Development37K今天更新

M5 Onboard

anthropics

精選

透過 USB 偵測 M5Stack ESP32 開發板，燒錄 UIFlow 2.0 韌體並安裝 MicroPython 應用程式套件。

Software Development37K今天更新

Cardputer Buddy

anthropics

精選

指導迭代 Cardputer-Adv 的 MicroPython 應用程式套件：新增應用程式、透過 USB 序列埠推送檔案、查看日誌並執行 REPL 指令。

Software Development37K今天更新

Dpop Adoption

google

精選

指導為 Google OAuth 平台實作 OAuth 2.0 DPoP（RFC 9449）傳送方約束的更新權杖。

Software Development21K今天更新

Gemini Live Api

google

精選

產生 Gemini Live API WebSocket 用戶端類別、測試、文件，以及用於雙向串流的示範介面。

Software Development21K今天更新

Gemini Api

google

精選

說明如何在 Google Agent Platform 上使用 Gen AI SDK 呼叫 Gemini API，涵蓋多種語言與多項功能。

Software Development21K今天更新