Gaik Add Examples

What it does

When your agent uses it

• Adding a new example
• Demonstrating a feature
• Creating a usage sample
• Showing how a building block

Example prompts

• “/gaik-add-examples”

Requirements

• Python 3

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

1. 1Choose the right location
2. 2Follow the standard file structure
3. 3Add or update README.md in the component/module directory covering
4. 4Update the parent README.md (software_components/README.md or software_modules/README.md) to list the new example.
5. 5Add sample input files if needed (PDFs, audio files, images) to an input/ subdirectory. Keep samples small and redistributable.

What it can do on your machine

Read from SKILL.md and the folder at commit e66fcca. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • pip
  • git
  • python
  • pnpm
  • bun
  • uv

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use pip, git, pnpm and uv, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Gaik Add Examples loads about 2.4k tokens when it runs. Until then it costs about 257 tokens; SKILL.md has 822 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~257

When it runs · the whole SKILL.md, loaded when a task matches

~2.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

• NoteMentions a .env fileSKILL.md:61

  v(Path(__file__).parent.parent.parent / ".env")

• NoteMentions a .env fileSKILL.md:78

  ample.py` → `.parent.parent.parent` for `.env`, `.parent.parent.parent.parent / "src"` for src

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from GAIK-project/gaik-toolkit at commit e66fcca, republished under its MIT licence (© GAIK-project). 822 words, ~2,373 tokens.

name

gaik-add-examples

description

Adds or updates working code examples for GAIK toolkit components and pipelines in implementation_layer/examples/. Use when adding a new example, demonstrating a feature, creating a usage sample, or showing how a building block or pipeline works. After the example is in place, offers optional follow-ups: update API docs (guidance_layer/docs/), update the Fumadocs website (guidance_layer/website/content/docs/), expose the feature in the demo app (toolkit_demo_app/api/routers + UI), and push a PyPI release tag. Covers software_components (extractor, parsers, transcriber, RAG, classifier, TTS, enhance_transcript, postgres_agent, tabular_agent, validators (LLMJudge / panel / pairwise / calibration), evaluators (ExtractionEvaluator, RAGEvaluator, BatchEvaluationRunner), form_understander, observability) and software_modules (AudioToStructuredData, DocumentsToStructuredData, RAGWorkflow, MultiSourceReportGenerator). Not for creating a brand-new component package — use build-software-component for that.

argument-hint

[component name or feature to demonstrate]

"""
Example: [one-line summary]
Workflow: [input] -> [step1] -> [step2] -> [output]
"""

from __future__ import annotations

import sys
from pathlib import Path

from dotenv import load_dotenv

# Load environment variables before importing gaik modules
load_dotenv(Path(__file__).parent.parent.parent / ".env")

# Add src directory to path to import modules (works without pip install)
sys.path.insert(0, str(Path(__file__).parent.parent.parent.parent / "src"))

from gaik... import ...


def main() -> None:
    # example code here


if __name__ == "__main__":
    main()

from gaik.software_components.config import get_openai_config, create_openai_client

config = get_openai_config(use_azure=True)   # Azure OpenAI
config = get_openai_config(use_azure=False)  # Standard OpenAI
client = create_openai_client(config)        # OpenAI/AzureOpenAI client

pipeline = DocumentsToStructuredData(use_azure=True)

from gaik.software_components.llm import get_llm_config, create_llm_client

config = get_llm_config("anthropic")  # or "openai", "azure", "aitta", "openai_compatible",
                                      #    "google", "vertex", "anthropic_foundry", "litellm"
client = create_llm_client(config)    # ProviderClient (chat / chat_parsed / chat_stream / embed)

© GAIK-project, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/gaik-add-examples of GAIK-project/gaik-toolkit.

Open the folder on GitHubat commit e66fcca