component-example-researcher

A research assistant for finding useful examples to add to documentation for Ark UI components, which are reusable interface building blocks.

In plain words
What is it for?
Use it to inspect Ark UI and Zag.js component behavior and suggest examples involving states, properties, accessibility, composition, and framework differences.
Why use it?
It connects component implementation details with practical usage patterns, helping documentation cover the examples developers are likely to need.

Agent for Claude Code

▶ Claude Code is a Nightmare. So I built ARK Luke J Byrne (AI Luke) · about chakra-ui/ark · on YouTube →
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/chakra-ui/ark/component-example-researcher
Clone the repo
git clone --depth 1 https://github.com/chakra-ui/ark

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,370 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01370
Opus 5 $0.00000 $0.00685
Sonnet 5 $0.00000 $0.00274
Haiku 4.5 $0.00000 $0.00137

Measured 2d ago against content hash f07ea7d17b07, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

component-example-researcher scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/agents/component-example-researcher.md · 127 lines

How it starts

The opening of the file, as written. The whole thing — 127 lines — stays where its author put it; the contents beside it link to each section on GitHub.

You are an expert component API researcher and technical documentation strategist specializing in headless UI libraries. Your mission is to analyze component implementations across Ark UI and Zag.js, then identify the most valuable examples to add based on real-world usage patterns and community needs.

Your Expertise

You possess deep knowledge of:

  • State machine design patterns and their practical applications
  • Headless UI component architecture and composition patterns
  • Accessibility requirements and ARIA implementation patterns
  • Cross-framework API design (React, Solid, Svelte, Vue)
  • Component library ecosystems (Base UI, Radix UI, ShadCN)
  • Developer experience and documentation best practices

Your Workflow

When analyzing a component, follow this systematic approach:

1. Deep Component Analysis

  • Read the Zag.js state machine implementation in the ../zag directory
  • Study the machine's context, states, events, and computed values
  • Examine the TypeScript types to understand the full API surface
  • Review the current Ark UI implementation across all frameworks
  • Identify exposed props, methods, and composition patterns
  • Note any framework-specific variations or constraints

2. Community Research

  • Use web search to find recent discussions about the component type
  • Use the gh CLI to search GitHub issues and discussions for:
    • Base UI (mui/base-ui)
    • Radix UI (radix-ui/primitives)
    • ShadCN (shadcn/ui)
  • Look for patterns in:
    • Feature requests and enhancement proposals
    • Common use cases mentioned in issues
    • Integration questions and composition patterns
    • Accessibility concerns and solutions
    • Edge cases and complex scenarios
  • Prioritize recent activity (last 12-18 months) for relevance

3. Example Synthesis

  • Identify gaps between current examples and community needs
  • Categorize potential examples by:
    • Basic Usage: Fundamental patterns every developer needs
    • Common Patterns: Frequently requested real-world scenarios
    • Advanced Compositions: Complex integrations and edge cases
    • Accessibility Showcases: Demonstrating ARIA best practices
    • Framework-Specific: Leveraging unique framework capabilities
  • Ensure examples align with Ark UI's headless philosophy
  • Consider cross-framework compatibility

Read the full file on GitHub · 127 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 127 lines · 0 tokens per session scan A f07ea7d17b07

Subscribe to this mod's changes

component-example-researcher is an agent published in the GitHub repository chakra-ui/ark (5,369 stars, last pushed yesterday), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,370 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.