# Tool reference

> Every tool on the Advibly MCP server, grouped by what it is for.

Source: https://advibly.com/docs/agents/tools



Use this page to choose a capability. Before calling it, read that tool's live
schema from MCP `tools/list`; the schema is authoritative for arguments,
defaults, models, constraints, and cost notes.

All tools act as the signed-in Advibly account. Anything that calls a model
spends that account's credits; read-only and organisational calls are free.

## The call contract [#the-call-contract]

Every tool schema includes a required `context` string. It must describe, in
15-25 words and in third person, why that call supports the user's goal. Do not
put credentials, personal data, or other secrets in it. MCP clients should
read this requirement from `tools/list`; the Advibly CLI fills it automatically.

`brand_id` is **required** on every generation tool. It decides where the
generation is filed, not whether brand styling is applied - that is a separate
`on_brand` argument.

For any workflow with several generated parts, create or reuse a project and
pass its `project_id` to every generation. The run is organised only when every
intermediate and final belongs to that project.

<Callout>
  The live list is always authoritative: `tools/list` on the server, or `advibly
    tools` from the CLI. This page groups and explains them.
</Callout>

## Choose the tool [#choose-the-tool]

| Need                                       | Use                                                 |
| ------------------------------------------ | --------------------------------------------------- |
| Inspect the account before work            | `advibly_list_brands`, `advibly_check_credits`      |
| Create a brand from its public site        | `advibly_onboard_brand`                             |
| Anchor an ad to a real product or asset    | `advibly_get_products`, `advibly_get_assets`        |
| Make one media asset                       | A matching `advibly_generate_*` tool                |
| Assemble clips, narration, music, and text | `advibly_render_composition`                        |
| Join clips with hard cuts only             | `advibly_stitch_videos`                             |
| Understand or cut an existing video        | `advibly_analyze_video`                             |
| Collect a pipeline's outputs               | `advibly_list_generations` filtered by `project_id` |
| Publish or schedule finished media         | `advibly_social_create_post`                        |

## Credits [#credits]

| Tool                    | What it does                                 |
| ----------------------- | -------------------------------------------- |
| `advibly_check_credits` | Current balance.                             |
| `advibly_buy_credits`   | Available credit packs, with checkout links. |

## Brands [#brands]

| Tool                            | What it does                                                   |
| ------------------------------- | -------------------------------------------------------------- |
| `advibly_list_brands`           | Every brand with its id and `brand_type`. &#x2A;*Start here.** |
| `advibly_get_brand`             | One brand's identity and research brief.                       |
| `advibly_get_brand_dossier`     | The full sourced knowledge base for a brand.                   |
| `advibly_update_brand`          | Change identity fields.                                        |
| `advibly_update_brand_document` | Write a new version of the brief or dossier.                   |
| `advibly_view_brandkit`         | The rendered brand style sheet.                                |
| `advibly_onboard_brand`         | Create the user's own brand from a URL, end to end.            |
| `advibly_quick_brand`           | A ready-to-generate brand from a URL, skipping onboarding.     |
| `advibly_list_quick_brands`     | List those.                                                    |

## Products and assets [#products-and-assets]

| Tool                        | What it does                                                        |
| --------------------------- | ------------------------------------------------------------------- |
| `advibly_get_products`      | The brand's product catalog. A product id becomes the ad's subject. |
| `advibly_get_assets`        | The brand's asset library.                                          |
| `advibly_create_upload_url` | A presigned `PUT` target. Preferred for anything of size.           |
| `advibly_upload_asset`      | Register an uploaded file as an asset.                              |

## Generation [#generation]

| Tool                             | What it does                    |
| -------------------------------- | ------------------------------- |
| `advibly_generate_image`         | A static image.                 |
| `advibly_generate_video`         | A video clip, with audio.       |
| `advibly_generate_talking_video` | An actor delivering a script.   |
| `advibly_generate_carousel`      | A multi-slide deck.             |
| `advibly_export_carousel_pdf`    | That deck as a PDF.             |
| `advibly_generate_voiceover`     | Text to speech.                 |
| `advibly_generate_music`         | A generated track.              |
| `advibly_list_actors`            | Stock actors and brand avatars. |

## Video post-production [#video-post-production]

| Tool                         | What it does                                                      |
| ---------------------------- | ----------------------------------------------------------------- |
| `advibly_render_composition` | Assemble a complete video in one call.                            |
| `advibly_stitch_videos`      | Join 2-12 clips with hard cuts. Free.                             |
| `advibly_add_subtitles`      | Burn in captions, 150+ languages, optional translation.           |
| `advibly_analyze_video`      | Analyse a video: ad breakdown, shots, transcript, cut plan. Free. |

## Jobs and projects [#jobs-and-projects]

| Tool                       | What it does                      |
| -------------------------- | --------------------------------- |
| `advibly_get_generation`   | Status and results. Poll this.    |
| `advibly_list_generations` | The library, filterable.          |
| `advibly_create_project`   | Open a project before a pipeline. |
| `advibly_list_projects`    | List them.                        |
| `advibly_update_project`   | Rename, or set the cover.         |

## Publishing [#publishing]

| Tool                               | What it does                                |
| ---------------------------------- | ------------------------------------------- |
| `advibly_social_list_accounts`     | Connected accounts and their `profile_id`s. |
| `advibly_social_create_post`       | Publish or schedule.                        |
| `advibly_social_update_post`       | Edit a scheduled post.                      |
| `advibly_social_delete_post`       | Delete one.                                 |
| `advibly_social_list_posts`        | List posts, optionally with performance.    |
| `advibly_social_get_post`          | One post.                                   |
| `advibly_social_get_profile_stats` | Account-level stats.                        |
| `advibly_social_arm_dm_automation` | Arm a comment-to-DM flow on a post.         |

## Generation results [#generation-results]

Generation calls wait briefly before returning:

* `completed`: use the returned URL. Do not make a redundant status call.
* `pending` or `processing`: keep the `generation_id`. The in-chat widget keeps
  polling; call `advibly_get_generation` only when a downstream tool needs the
  finished URL.
* `failed` or `rejected`: the credits are refunded. Use the returned reason to
  change the next attempt.

See [Generation statuses](/reference/generation-statuses).
