AgentSkillsCN

core-sdk

凯拉什核心 SDK 基础知识,涵盖工作流创建、节点模式、连接配置、运行时执行、参数传递、错误处理、循环工作流、异步模式、MCP 集成以及安装流程。在咨询“工作流基础”“核心 SDK”“创建工作流”“工作流构建器”“节点模式”“连接配置”“运行时”“参数”“导入”“安装”“快速上手”“工作流执行”“异步工作流”“错误处理”“循环工作流”“PythonCode 节点”“SwitchNode”或“MCP 集成”等相关问题时,可参考本指南。

SKILL.md
--- frontmatter
name: core-sdk
description: "Kailash Core SDK fundamentals including workflow creation, node patterns, connections, runtime execution, parameter passing, error handling, cyclic workflows, async patterns, MCP integration, and installation. Use when asking about 'workflow basics', 'core sdk', 'create workflow', 'workflow builder', 'node patterns', 'connections', 'runtime', 'parameters', 'imports', 'installation', 'getting started', 'workflow execution', 'async workflows', 'error handling', 'cyclic workflows', 'PythonCode node', 'SwitchNode', or 'MCP integration'."

Kailash Core SDK - Foundational Skills

Comprehensive guide to Kailash Core SDK fundamentals for workflow automation and integration.

Features

The Core SDK provides the foundational building blocks for creating custom workflows with fine-grained control:

  • 110+ Workflow Nodes: Pre-built nodes for AI, API, database, file operations, logic, and more
  • WorkflowBuilder API: String-based workflow construction with type safety
  • Dual Runtime Support: AsyncLocalRuntime (Docker/FastAPI) and LocalRuntime (CLI/scripts)
  • Advanced Patterns: Cyclic workflows, conditional execution, error handling
  • MCP Integration: Built-in Model Context Protocol support
  • Parameter Passing: Flexible data flow between nodes
  • Zero Configuration: Auto-detection of runtime context
  • Production Ready: Enterprise features including monitoring, validation, and debugging

Quick Start

python
from kailash.workflow.builder import WorkflowBuilder
from kailash.runtime.local import LocalRuntime

workflow = WorkflowBuilder()
workflow.add_node("NodeName", "id", {"param": "value"})
runtime = LocalRuntime()
results, run_id = runtime.execute(workflow.build())

Reference Documentation

Getting Started

Core Patterns

Advanced Topics

Key Concepts

WorkflowBuilder Pattern

  • String-based node API: workflow.add_node("NodeName", "id", {})
  • Always call .build() before execution
  • Never workflow.execute(runtime) - always runtime.execute(workflow.build())

Runtime Selection

  • AsyncLocalRuntime: For Docker/FastAPI (async contexts) - async-first, no threading, 10-100x faster
  • LocalRuntime: For CLI/scripts (sync contexts) - synchronous execution with thread support
  • get_runtime(): Auto-detection helper that selects appropriate runtime based on context

Both runtimes return identical structure: (results, run_id) tuple.

Runtime Architecture

Both LocalRuntime and AsyncLocalRuntime inherit from BaseRuntime with shared capabilities:

BaseRuntime Foundation:

  • 29 configuration parameters (debug, enable_cycles, conditional_execution, connection_validation, etc.)
  • Execution metadata management
  • Common initialization and validation modes (strict, warn, off)

Shared Mixins:

  • CycleExecutionMixin: Cyclic workflow execution with validation
  • ValidationMixin: Workflow structure validation (5 methods)
  • ConditionalExecutionMixin: Conditional execution and branching with SwitchNode support

AsyncLocalRuntime-Specific:

  • WorkflowAnalyzer for optimal execution strategy
  • Level-based parallelism for concurrent execution
  • Thread pool for sync nodes without blocking
  • Semaphore control to prevent resource exhaustion

Critical Rules

  • ✅ ALWAYS: runtime.execute(workflow.build())
  • ✅ String-based nodes: workflow.add_node("NodeName", "id", {})
  • ✅ 4-parameter connections: (source_id, source_param, target_id, target_param)
  • ✅ Docker/FastAPI: Use AsyncLocalRuntime (mandatory)
  • ✅ CLI/Scripts: Use LocalRuntime
  • ❌ NEVER: workflow.execute(runtime)
  • ❌ NEVER: Instance-based nodes
  • ❌ NEVER: Use LocalRuntime in Docker (causes hangs)

When to Use This Skill

Use this skill when you need to:

  • Create custom workflows from scratch
  • Understand workflow fundamentals
  • Learn node patterns and connections
  • Set up runtime execution
  • Handle errors in workflows
  • Implement cyclic or async patterns
  • Integrate with MCP
  • Get started with Kailash SDK

Related Skills

Support

For complex workflows or debugging, invoke:

  • pattern-expert - Workflow patterns and cyclic debugging
  • sdk-navigator - Find specific nodes or patterns
  • testing-specialist - Test workflow implementations