Skip to content
PromptKit Logo PromptKit

SDK How-To Guides

Practical, task-focused guides for common SDK operations.

Getting Started

Section titled “Getting Started”

Tools & Functions

Section titled “Tools & Functions”

Integrations

Section titled “Integrations”

Declarative Configuration

Section titled “Declarative Configuration”
  • Use RuntimeConfig - Configure the SDK declaratively with a YAML file
  • Exec Tools - Bind tools to external subprocesses in any language
  • Exec Hooks - Add external hooks (provider, tool, session) via subprocesses

Variables & Templates

Section titled “Variables & Templates”

Context Management

Section titled “Context Management”
  • Manage Context - Configure token budgets and relevance-based truncation

Media Processing

Section titled “Media Processing”
  • Preprocess Images - Automatically resize and optimize images before sending to LLM providers

Evaluation

Section titled “Evaluation”
  • Run Evals - Evaluate conversations with sdk.Evaluate()

Observability

Section titled “Observability”

Quick Reference

Section titled “Quick Reference”

Open a Conversation

Section titled “Open a Conversation”
conv, err := sdk.Open("./app.pack.json", "assistant")
if err != nil {
    log.Fatal(err)
}
defer conv.Close()

Send Message

Section titled “Send Message”
resp, err := conv.Send(ctx, "Hello!")
fmt.Println(resp.Text())

Stream Response

Section titled “Stream Response”
for chunk := range conv.Stream(ctx, "Tell me a story") {
    if chunk.Type == sdk.ChunkDone {
        break
    }
    fmt.Print(chunk.Text)
}

Register Tool

Section titled “Register Tool”
conv.OnTool("get_time", func(args map[string]any) (any, error) {
    return time.Now().Format(time.RFC3339), nil
})

Set Variables

Section titled “Set Variables”
conv.SetVar("user_name", "Alice")
conv.SetVars(map[string]any{
    "role":     "admin",
    "language": "en",
})

Subscribe to Events

Section titled “Subscribe to Events”
hooks.On(conv, events.EventProviderCallCompleted, func(e *events.Event) {
    log.Printf("Provider call completed: %s", e.Type)
})

By Use Case

Section titled “By Use Case”

Building a Chatbot

Section titled “Building a Chatbot”
  1. Open a Conversation
  2. Send Messages
  3. Manage Variables

Adding Function Calling

Section titled “Adding Function Calling”
  1. Register Tools
  2. HTTP Tools (for external APIs)
  3. Configure MCP Servers (for MCP tools)

Connecting External Agents

Section titled “Connecting External Agents”
  1. Connect A2A Agents
  2. Configure MCP Servers

Declarative Setup

Section titled “Declarative Setup”
  1. Use RuntimeConfig (replace boilerplate with YAML)
  2. Exec Tools (tools in Python, Node.js, etc.)
  3. Exec Hooks (external guardrails and audit)

Building Safe AI Agents

Section titled “Building Safe AI Agents”
  1. Register Tools (see Async Tools section for HITL)
  2. Exec Hooks (external guardrails)
  3. Monitor Events

Evaluating Conversation Quality

Section titled “Evaluating Conversation Quality”
  1. Run Evals
  2. Monitor Events

See Also

Section titled “See Also”