help-beacon

Configure a floating help beacon in React apps with article search and Anthropic API grounding.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/charlieclark/skill-help --skill help-beacon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: help-beacon
Source: https://github.com/charlieclark/skill-help/tree/main/skills/help-beacon
Command: npx skills add https://github.com/charlieclark/skill-help --skill help-beacon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides an AI-powered floating help beacon that sits as a lightweight widget in a React app, enabling users to get quick, contextual help by querying documentation and AI responses, reducing support friction.

Core Features & Use Cases

  • Floating beacon widget for React apps that surfaces instant help based on your documentation and articles.
  • Client-side search of article titles, tags, and content to surface relevant results before querying the AI.
  • Claude AI integration via the Anthropic API to ground responses in your docs; a human fallback offers a "Contact Support" option when the AI cannot answer.
  • Simple integration: drop in a HelpBeacon component, configure help.config.json, and customize greeting and position.

Quick Start

Install the beacon in your project, render the HelpBeacon component in your app layout, and configure help.config.json with beacon settings. Ensure ANTHROPIC_API_KEY is available in your environment and then start your app to see the floating beacon in action.

Frequently Asked Questions about help-beacon

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add an AI-powered help beacon to my React application?

To add a help beacon, render the HelpBeacon component in your app layout and configure settings via help.config.json. It functions as a floating widget that surfaces instant documentation search results and Claude AI responses.

What is an AI help beacon and how does it answer user questions?

An AI help beacon is a floating widget that performs client-side article search before grounding responses using the Anthropic API. It provides quick, contextual answers from your documentation and falls back to human support if unresolved.

Do I need an Anthropic API key to use a Claude AI help widget?

Yes, you need the ANTHROPIC_API_KEY environment variable configured to enable Claude AI grounding. The help beacon uses this API key to process natural language queries against your documentation.

Can I customize the floating help widget position and greeting in React?

Yes, you can customize the help beacon's greeting and position by modifying the help.config.json file. This configuration file controls the beacon settings for your React application's floating widget.

What happens when the AI help beacon cannot resolve a user query?

When the AI help beacon cannot resolve a query, it provides a human fallback option. This offers users a Contact Support option to ensure unresolved queries are redirected to human assistance.

How to configure documentation articles for a React help beacon?

You configure documentation by creating an articles directory containing your help content. The help beacon performs client-side search across article titles, tags, and content to surface relevant results before querying the AI.