Skip to content

AGENTS.md

Latest commit

 

History

History
63 lines (52 loc) · 6.72 KB

AGENTS.md

File metadata and controls

63 lines (52 loc) · 6.72 KB
Raw

AGENTS.md

Your name is Dave and developers will use your name when interacting with you.

The manual has been split into separate chapter files in the .manual/ directory. Read only the chapters relevant to your task. Each chapter file begins with its own section index — open the chapter file when you need section-level detail.

You will want to look at Chapter 20: Developer Guide for detailed information about the project structure, code, and workflows.

Basic Rules

  • After modifying any .go file, always run go vet and gofmt -s -w on the changed files.
  • After modifying any .go file, always run staticcheck and go fix on the changed package.
  • You need these env vars to run test
    • export RUN_IN_PARALLEL=yes
    • export GITHUB_WORKSPACE=
  • Never perform a full repo test run and never run tests from this location sdk/kronk/tests.

MCP Services

Kronk has an MCP service and these are settings:

"mcp": {
    "Kronk": {
        "type": "remote",
        "url": "http://localhost:9000/mcp",
        "type": "streamableHttp",
        "apis": [
            {
                "api": "web_search",
                "desc": "Performs a web search for the given query. Returns a list of relevant web pages with titles, URLs, and descriptions. Use this for general information gathering, research, and finding specific web resources."
            }
        ],
    }
}

MANUAL Index

Open a chapter file to see its section-level table of contents.

Chapter Topics
Chapter 1: Introduction What is Kronk (SDK + Server), key features, supported platforms, architecture overview
Chapter 2: Installation & Quick Start Prerequisites, CLI install (Homebrew, go install, binary, Docker / OCI), libraries, downloading models, starting server, model config file
Chapter 3: Model Configuration GPU config, KV cache, flash attention, NSeqMax, VRAM estimation, GGUF quantization, MoE vs dense vs hybrid performance, speculative decoding
Chapter 4: Batch Processing Slots, sequences, request flow, memory overhead, concurrency by model type
Chapter 5: Message Caching Incremental Message Cache (IMC), hybrid model IMC, multi-user IMC, cache invalidation
Chapter 6: Speculative Decoding & MTP User guide for speculative decoding: separate-GGUF vs auto-detected MTP drafters, when to choose each, acceptance/adaptive throttle, observability, known limitations
Chapter 7: YaRN Extended Context RoPE scaling, YaRN configuration, context extension
Chapter 8: Model Server Server start/stop, configuration, model caching, config files, catalog system
Chapter 9: API Endpoints Chat completions, Responses API, embeddings, reranking, tool calling
Chapter 10: Request Parameters Sampling, repetition control, generation control, grammar, logprobs, cache ID
Chapter 11: Multi-Modal Models Vision models, audio models, media input formats
Chapter 12: Security & Authentication JWT auth, key management, token creation, rate limiting
Chapter 13: Browser UI (BUI) Web interface, downloading libraries/models, catalog browsing, model management, key/token management, apps, model playground
Chapter 14: Client Integration OpenCode install + agent bundles in .agents/ (default + rote), make targets, model config and swapping models, OpenWebUI, Python SDK, curl, LangChain
Chapter 15: Observability Debug server, Prometheus metrics, pprof profiling, tracing
Chapter 16: MCP Service Brave Search, MCP configuration, OpenCode client setup, curl testing
Chapter 17: Troubleshooting Common issues, error messages, debugging tips
Chapter 18: Bucky (Audio Transcription) whisper.cpp-based transcription: install/libs, model catalog, server/pool config, CLI, BUI, API endpoint, SDK quick-start, streaming API (Feed/Events/Reset, VAD, live-mic example), languages, troubleshooting
Chapter 19: Malina (Image Generation) Experimental stable-diffusion.cpp SDK: libraries, curated model bundles, text-to-image, image-to-image, FLUX.2 components, progress/logging, AVI encoding, examples, limitations
Chapter 20: Developer Guide Build commands, project architecture, BUI development, code style, SDK internals, MTP engine internals, Bucky/Malina ownership, CI workflows (lint/test, goreleaser, container build & publish), version stamping