> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Famulor Skill

> Install the open-source skill for voice prompts, WhatsApp, web chat, email, and workspace workflows

**Famulor Skill** teaches your AI client how to design assistants and work with Famulor. It includes prompt templates, channel guidance, testing scenarios, and references for the public API, MCP, CLI, and TypeScript SDK.

[View the repository](https://github.com/Famulor-SI/Famulor-Skill) · [Download the latest release](https://github.com/Famulor-SI/Famulor-Skill/releases/latest) · [Detailed installation guide](https://github.com/Famulor-SI/Famulor-Skill/blob/main/docs/installation.md)

> [!NOTE]
>
> The **skill provides instructions**. An **MCP connection provides authorized workspace access**. Installing the skill alone does not connect your account or expand an existing connection's permissions. You can draft prompts without a connection; reading or changing workspace data requires one.

## Choose your starting point

| You want to… | Start with |
| - | - |
| Build a voice receptionist or booking assistant | [Assistant design and voice templates](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/assistant-design.md) |
| Adapt an assistant to WhatsApp, web chat, or email | [Channel guidance and prompt examples](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/messaging-and-channels.md) |
| Improve conversation quality | [Testing and evaluation](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/testing-and-evaluation.md) |
| Find an endpoint, CLI command, or SDK method | [API and SDK guide](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/api-and-sdk.md) |
| Prepare campaigns, knowledge, or automations | [Workflow examples](https://github.com/Famulor-SI/Famulor-Skill/blob/main/docs/use-cases.md) and [MCP use cases](https://docs.famulor.io/mcp/use-cases.md) |

## Learn from complete examples

Use the [worked-example library](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/README.md) to see a complete assistant design inspired by the public [Famulor demos](https://app.famulor.io/demo).

| Example | What it teaches |
| - | - |
| [Hotel front desk](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/hotel-front-desk.md) | Greeting, hotel knowledge, actual availability, booking confirmation and recovery |
| [Drive-thru](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/drive-thru.md) | Correcting a basket, checking its quote and submitting once |
| [Order support](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/order-support.md) | Shared business policy with voice, WhatsApp, webchat and email adaptations |
| [Lead qualification](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/lead-qualification.md) | Useful discovery, appropriate next steps and respectful opt-out handling |

Each example includes a filled brief, complete prompt, setting placement, required runtime tools, an illustrative conversation and acceptance checks. The [assistant deliverable](https://github.com/Famulor-SI/Famulor-Skill/blob/main/skills/famulor-skill/references/examples/assistant-deliverable.md) shows how an agent should present the finished proposal and verification status. The businesses and example outcomes are fictional: gallery role-play does not prove that a booking or order happened. Connect real tools and verify their results before making those claims to customers.

## Install

For coding agents that support Agent Skills, run:

```bash theme={null}
npx skills add Famulor-SI/Famulor-Skill --skill famulor-skill
```

Choose your client in the installer. It installs into the current project by default; add `-g` for a global installation. Review the package before installing it. For workspace actions, add a remote **Streamable HTTP** MCP connection and complete OAuth:

```text theme={null}
https://app.famulor.io/mcp
```

Use the domain shown in **Settings → API & MCP** for a white-label workspace. Your plan must include **Connect AI / MCP**, and your workspace role and approved scopes must allow the requested action. A focused URL such as `https://app.famulor.io/mcp?toolsets=assistants,calls` limits tool discovery without granting extra permissions.

> [tab] Claude Code
>
> Install the bundled plugin from the repository's marketplace:
>
> ```text theme={null}
> /plugin marketplace add Famulor-SI/Famulor-Skill
> /plugin install famulor@famulor
> ```
>
> Open `/mcp` and authenticate Famulor. This package includes both the skill and MCP configuration. If you installed only the skill with `npx skills`, add the connection separately:
>
> ```bash theme={null}
> claude mcp add --transport http famulor https://app.famulor.io/mcp
> ```

> [tab] Claude web and desktop
>
> 1. In Famulor, open **Connect → Famulor Skill → Download ZIP**. You can also get `famulor-skill.zip` from the [latest release](https://github.com/Famulor-SI/Famulor-Skill/releases/latest).
> 2. Open **Customize → Skills → + → Create skill → Upload a skill** and upload that ZIP. Do not upload the whole repository ZIP.
> 3. Enable the skill. Your account or organization must permit skills and code execution.
> 4. Connect Famulor under **Customize → Connectors**. Use a custom connector with the MCP URL for the tools you need.
> 5. Start a new conversation and ask Claude to use Famulor Skill.
>
> The [Famulor Assistants & History directory connector](https://claude.ai/directory/famulor-assistants-history) provides read-only access. It cannot save prompts or send messages. See [Claude's skill upload guide](https://support.claude.com/en/articles/12512180-use-skills-in-claude) if your controls differ.

> [tab] ChatGPT
>
> Install the [official Famulor plugin](https://chatgpt.com/plugins/plugin_asdk_app_6a8a46791ed08191a79aa4c98f34d772), connect your account, and select **@Famulor** in a chat. This listing provides **11 read-only tools** for assistant and history review.
>
> For a custom domain or additional authorized tools, open **ChatGPT Plugins → + → Add custom MCP server** on the web. Enter the MCP URL, choose **OAuth**, review the connection, and create it as a plugin. Sign in, select your workspace, approve the needed access, then install and select the resulting plugin with **@**.
>
> Local skill installation does not configure ChatGPT web, and the official plugin does not automatically include this GitHub skill release. For prompt drafting, provide the relevant template and business requirements in the chat. Account and organization controls may restrict custom connections; see [OpenAI's current custom MCP guide](https://developers.openai.com/api/docs/guides/custom-mcp-server).

> [tab] Codex
>
> After installing the skill, configure and verify MCP:
>
> ```bash theme={null}
> codex mcp add famulor --url https://app.famulor.io/mcp
> codex mcp login famulor
> codex mcp get famulor
> ```
>
> Restart the session and ask Codex to use `$famulor-skill`. IDE clients can also add the connection under **MCP servers → Add server → Streamable HTTP**.

> [tab] Cursor
>
> Choose Cursor in the skill installer. Add the remote URL in Cursor's MCP settings, or use this project configuration in `.cursor/mcp.json`:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "famulor": {
>       "url": "https://app.famulor.io/mcp"
>     }
>   }
> }
> ```
>
> Authenticate when prompted and verify that the Famulor tools are enabled.

> [tab] Gemini CLI
>
> Install the extension, which bundles the skill and MCP configuration:
>
> ```bash theme={null}
> gemini extensions install https://github.com/Famulor-SI/Famulor-Skill
> ```
>
> Review the requested capabilities. Run `/mcp auth famulor` if authentication is requested, then `/extensions list` to check the installation.

For other compatible clients, use the installer or copy the complete `skills/famulor-skill/` folder, including its references, scripts, and templates. Copying only `SKILL.md` omits the supporting guides. The release also provides `famulor.skill` for compatible importers.

## Verify with a read-only request

> Use Famulor to list my assistants. Tell me which workspace is connected. Do not change anything.

Then try a focused review:

> Use Famulor Skill to review my support assistant for website text chat. Propose a revised prompt and three test conversations. Do not save or send anything.

A downloaded package or completed OAuth screen does not prove that a tool call succeeded. Confirm that the client returned actual data from the intended workspace. On a read-only connection, review and draft workflows work; saving changes requires separate write access.

## Prompting that matches each channel

Keep business policy, trusted sources, and action rules in the shared system prompt. Use **Additional channel instructions** for tone, length, and layout when Manual channel responses is included in your plan.

* **Voice:** concise spoken turns, one clear question, an appropriate greeting, and real transfer or booking tools.
* **WhatsApp:** compact messages, human takeover, the current service window, and approved templates for authorized outreach when required. Use 2–3 native reply buttons for short known choices in a conversation. [WhatsApp quick replies](https://docs.famulor.io/channels/whatsapp.md#quick-replies-in-conversations)
* **Web chat:** readable links, pre-chat context, useful written answers, and a test of the actual widget. The website chat can show 2–5 clickable buttons when a visitor picks one of a few known choices. [Widget quick replies](https://docs.famulor.io/web-widget.md#quick-replies)
* **Email:** complete body text, the right thread and signature behavior, and a clear distinction between a draft and a sent reply.

A prompt cannot connect a calendar, create a tool, grant permissions, or prove a delivery. The skill guides the client to inspect configuration, resolve real resource IDs, use supported actions, and verify the result. Start with the [use-case requests](https://github.com/Famulor-SI/Famulor-Skill/blob/main/docs/use-cases.md), then test the channel your customers will actually use.

## Update and troubleshoot

For an installer-managed skill, run `npx skills check`, then `npx skills update`. For a manually uploaded Claude skill, upload the latest release ZIP. Keep the MCP connection separately authorized; removing local files does not necessarily revoke OAuth access.

| Symptom | Next step |
| - | - |
| Skill installed, no tools | Add the MCP connection, authenticate, and restart the client session. |
| Only 11 read-only tools | You connected the directory profile. Use a separately authorized custom connection for broader actions. |
| Cannot save an assistant | Check the workspace, role, approved scopes, and plan. |
| A write timed out | Read current state before retrying; the first action may have completed. |
| Installation controls differ | Follow the linked [maintained installation guide](https://github.com/Famulor-SI/Famulor-Skill/blob/main/docs/installation.md) and your client's official documentation. |

Use the [repository's issues](https://github.com/Famulor-SI/Famulor-Skill/issues) for reproducible skill or documentation problems. Remove customer data and credentials before sharing an example. For account-specific help, use [Famulor support](https://docs.famulor.io/support.md).

## Company senders and RCS

The Famulor skill can prepare an RCS company application, explain the quoted one-time credits and track verification. RCS stays within the SMS channel. Confirm the exact setup quote before submission and the intended recipient/content before a live send. Use SMS-only, RCS with explicit SMS fallback, or RCS-only according to the saved channel policy.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.