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

# Claude Code Plugin

> Встановіть Ayrshare plugin для Claude Code для публікації, планування та аналізу соціальних постів прямо з редактора — з передпублікаційною валідацією, підтвердженням перед публікацією, чернетками у голосі бренду та зчитуванням аналітики.

Ayrshare plugin для Claude Code містить конфігурацію [MCP Server](/additional/mcp-action-server), команду налаштування, agents, skills та safety hook. Після встановлення ви можете публікувати пости, отримувати історію та аналітику, керувати профілями тощо — безпосередньо з Claude Code. Перед тим, як щось буде опубліковано, агент валідує кожен пост за правилами цільової мережі та просить вас підтвердити, ловлячи легко уникнені відхилення заздалегідь. Історія постів доступна для узгодження з голосом бренду, а аналітику можна прочитати, щоб інформувати наступний пост.

Plugin — з відкритим кодом. Дивіться репозиторій для внутрішніх деталей: [ayrshare/ayrshare-social-media-api-claude-plugin](https://github.com/ayrshare/ayrshare-social-media-api-claude-plugin).

## Встановлення

<Steps>
  <Step title="Додайте marketplace (одноразово)">
    ```bash theme={"system"}
    claude plugin marketplace add ayrshare/ayrshare-social-media-api-claude-plugin
    ```
  </Step>

  <Step title="Встановіть plugin">
    ```bash theme={"system"}
    claude plugin install ayrshare@ayrshare
    ```
  </Step>
</Steps>

### Області встановлення (Scopes)

| Scope                     | Де застосовується                                             |
| ------------------------- | ------------------------------------------------------------- |
| Global (за замовчуванням) | Кожен проєкт на цій машині.                                   |
| `--scope local`           | Поточний проєкт, не комітиться в git.                         |
| `--scope project`         | Поточний проєкт, комітиться і поширюється між вашою командою. |

<Note>
  CLI Claude Code називає global scope як `--scope user`.
</Note>

## Облікові дані

Надайте ваш API-ключ Ayrshare одним із цих способів:

<ul class="custom-bullets">
  <li>Запустіть `/ayrshare:setup`, щоб налаштувати або оновити ключ.</li>
  <li>Встановіть змінну середовища `AYRSHARE_API_KEY`.</li>
</ul>

`.mcp.json` plugin вже оголошує заголовок `Authorization` плюс необов'язкові заголовки `Profile-Key` та X BYOK, кожен з порожнім значенням за замовчуванням (`${VAR:-}`), тож ви вмикаєте заголовок просто встановивши його змінну середовища (Claude Code підставляє значення при запуску). Щоб націлитися на sub-profile при кожному виклику, встановіть `AYRSHARE_PROFILE_KEY` (через `/ayrshare:setup` або блок `env` вашого `settings.json`) і перезапустіть Claude Code; вкладений заголовок `Profile-Key` містить його і залишається порожнім (розглядається як не наданий), коли не встановлено. Щоб націлитися на sub-profile для одного виклику, натомість передайте аргумент інструменту `profileKey` (без змін конфігурації). Вам не потрібно редагувати вкладений `.mcp.json` і не слід, оскільки `claude plugin update` перезаписує його.

<Warning>
  MCP-сервер ініціалізується на початку сесії. **Перезапустіть Claude Code** після встановлення plugin або зміни ключа.
</Warning>

### X/Twitter BYO credentials

Публікація в X/Twitter потребує ваших власних облікових даних X Developer App (обов'язковий X BYO-key, що набуває чинності 31 березня 2026 року; див. [API Overview](/apis/overview#xtwitter-byo-credentials)). Вкладений `.mcp.json` вже оголошує обидва заголовки X BYOK з порожніми значеннями за замовчуванням, поряд з `Authorization` і `Profile-Key`:

```json theme={"system"}
"headers": {
  "Authorization": "Bearer ${AYRSHARE_API_KEY}",
  "Profile-Key": "${AYRSHARE_PROFILE_KEY:-}",
  "X-Twitter-OAuth1-Api-Key": "${X_TWITTER_OAUTH1_API_KEY:-}",
  "X-Twitter-OAuth1-Api-Secret": "${X_TWITTER_OAUTH1_API_SECRET:-}"
}
```

Тому ви лише встановлюєте відповідні змінні середовища (`X_TWITTER_OAUTH1_API_KEY`, `X_TWITTER_OAUTH1_API_SECRET`) через `/ayrshare:setup` або `env` вашого `settings.json`, потім **перезапускаєте Claude Code**; ви не редагуєте вкладений `.mcp.json` (він перезаписується при `claude plugin update`). Встановіть **обидва** або жодного: без обох, виклик X/Twitter повертає помилку `419` (`x_credentials_required`); з встановленим лише одним, повертається помилка `400`. Це одна пара ключів на обліковий запис Ayrshare, надсилається з кожним запитом, спрямованим на X (та сама пара для всіх sub-profiles).

<Note>
  Віддаєте перевагу прямому підключенню перед plugin? Ті самі BYO-заголовки можна передати через `claude mcp add --header` — див. [Connect & Setup → X/Twitter BYO credentials](/additional/mcp-action-connect#xtwitter-byo-credentials).
</Note>

## Що поставляється

### Command

<ul class="custom-bullets">
  <li>`/ayrshare:setup` — налаштувати або оновити API-ключ Ayrshare.</li>
</ul>

### Agents

<ul class="custom-bullets">
  <li>`social-manager`: публікує, планує та аналізує контент на різних платформах.</li>
  <li>`profile-manager`: створює та перераховує профілі і генерує URL для соціального зв'язку JWT для клієнтських профілів під обліковим записом Business.</li>
  <li>`insights-analyst`: звітування лише для читання. Витягує метрики та історію постів і підсумовує продуктивність; ніколи не публікує, не коментує, не надсилає повідомлення і не модифікує нічого.</li>
</ul>

### Skills

| Skill                        | Призначення                                                            |
| ---------------------------- | ---------------------------------------------------------------------- |
| `getting-started`            | Орієнтуйтеся та підключайтесь для першого використання.                |
| `post`                       | Створюйте, валідуйте, оновлюйте та повторюйте пости.                   |
| `history`                    | Отримуйте історію постів і платформ.                                   |
| `analytics`                  | Витягуйте аналітику для окремого поста та на рівні облікового запису.  |
| `comments`                   | Читайте, додавайте та відповідайте на коментарі.                       |
| `messages`                   | Читайте та надсилайте прямі повідомлення і налаштовуйте автовідповіді. |
| `profiles`                   | Створюйте та перераховуйте sub-profiles.                               |
| `media`                      | Перевіряйте доступність URL медіа.                                     |
| `generate`                   | Робіть чернетки постів через ШІ та рекомендуйте хештеги.               |
| `webhooks`                   | Реєструйте, скасовуйте реєстрацію та перераховуйте webhooks.           |
| `errors`                     | Розшифровуйте коди помилок Ayrshare.                                   |
| `draft-in-brand-voice`       | Створюйте чернетки постів у постійному голосі бренду.                  |
| `plan-and-schedule-campaign` | Плануйте та плануйте розклад для кампанії з декількох постів.          |

### Confirmation hook

Hook `PreToolUse` запитує підтвердження перед будь-якою дією публікації або надсилання. Він охоплює саме ці 7 інструментів:

<ul class="custom-bullets">
  <li>`create_post`</li>
  <li>`update_post`</li>
  <li>`retry_post`</li>
  <li>`add_comment`</li>
  <li>`reply_comment`</li>
  <li>`send_message`</li>
  <li>`set_auto_response`</li>
</ul>

## FAQ

<AccordionGroup>
  <Accordion title="Чи валідує plugin пости перед публікацією?">
    Так. Plugin запускає `validate_post` для сухого прогону вашого контенту через правила кожної мережі — довжину, формат і вимоги до медіа — перед публікацією, тож ви ловите легко уникнені відхилення заздалегідь.
  </Accordion>

  <Accordion title="Чи запитує він мене перед публікацією на моїх активних облікових записах?">
    Так. Hook підтвердження `PreToolUse` пропонує вам схвалити перед будь-якою дією публікації або надсилання: `create_post`, `update_post`, `retry_post`, `add_comment`, `reply_comment`, `send_message` та `set_auto_response`.
  </Accordion>

  <Accordion title="Чи може plugin відповідати голосу мого бренду?">
    Так. Skill `draft-in-brand-voice` читає вашу історію постів, щоб створити чернетки нового тексту в постійному голосі бренду. Він створює лише чернетки — нічого не публікується без вашого підтвердження.
  </Accordion>

  <Accordion title="Чи можу я читати аналітику для інформування наступного поста?">
    Так. Інструменти аналітики повертають метрики для окремого поста та на рівні облікового запису, щоб ви могли прочитати результати та дозволити їм направляти ваш наступний пост.
  </Accordion>

  <Accordion title="Що мені потрібно для використання plugin?">
    API-ключ Ayrshare (ключ плану Business для profiles і sub-profiles) та Claude Code. Налаштуйте ключ за допомогою `/ayrshare:setup` або змінної середовища `AYRSHARE_API_KEY`, потім перезапустіть Claude Code.
  </Accordion>

  <Accordion title="Чи потрібне додаткове налаштування для публікації в X/Twitter?">
    Так. X/Twitter потребує ваших власних OAuth 1.0a облікових даних, доданих як два заголовки підключення (`X-Twitter-OAuth1-Api-Key` та `X-Twitter-OAuth1-Api-Secret`). Див. [X/Twitter BYO credentials](#xtwitter-byo-credentials) вище.
  </Accordion>
</AccordionGroup>

## Наступні кроки

<CardGroup cols={2}>
  <Card title="Connect & Setup" icon="plug" href="/additional/mcp-action-connect" horizontal>
    Автентифікація, націлювання на профіль і BYO credentials.
  </Card>

  <Card title="Tool Catalog" icon="list" href="/additional/mcp-action-tools" horizontal>
    27 інструментів, згрупованих за доменами, з областю дії та призначенням.
  </Card>
</CardGroup>