MCP server reference
Ignix exposes 280 tools over the Model Context Protocol, so an AI assistant can publish, answer messages, read analytics and build automations on your behalf. This page lists every one of them and is generated from the server's own registry.
Connecting
The server is remote and speaks Streamable HTTP over HTTPS, with OAuth 2.1 and a consent screen where you choose which workspace the assistant may reach. In the app, the address and the token live in Settings → MCP server.
{ "mcpServers": { "ignix": { "url": "https://app.ignix.social/api/mcp" } } }Reading this list
Each tool is marked read-only (only reads), writes (changes something in Ignix) or destructive (deletes, unpublishes or reaches a real person). Assistants are expected to confirm destructive calls with you first.
Accounts and workspaces
| Tool | What it does | Access |
|---|---|---|
list_accounts | List the social accounts connected to this organization. | read-only |
list_workspaces | List the workspaces (brands / clients) of this organization. | read-only |
check_account_health | List connected accounts that need attention: token expired or about to expire (reconnect / expiring, the human must reconnect them in Ignix), or messaging restricted by Meta on a Facebook Page (restricted: automations for it are paused and resume by themselves once Meta lifts the restriction; check the Page status in Meta Business Suite). | read-only |
get_network_rules | Publishing and automation rules for a social network: character limit, media requirements, supported content types (reel, story, carousel, thread), and which inbox automations that network allows. | read-only |
get_organization | Organization name, timezone and plan. | read-only |
list_account_summary | One-shot overview: every connected account with how many posts it has scheduled and when the next one goes out. | read-only |
sync_accounts | Re-read the accounts from the networks. | destructive |
create_workspace | Create a workspace (a separate brand or client, with its own accounts, library and knowledge) or rename an existing one.. | destructive |
list_account_media | List images and videos from posts the connected accounts already published (posts made outside Ignix included), newest first, each with url (ready to reuse as post media), type, thumbUrl and postedAt, plus count. | read-only |
research_account | What is working for a PUBLIC Instagram, TikTok or YouTube account or Facebook PAGE: its profile and its latest reels or Shorts with views, likes and comments, the account's median views and which pieces stand out (2× the median or more). | writes |
Publishing
| Tool | What it does | Access |
|---|---|---|
list_posts | List posts created in Ignix (drafts, pending approval, scheduled, publishing, published, failed), each with id, status and failure detail, text, scheduledFor, media and target accounts, plus count (all that match). | read-only |
get_post | Read one Ignix post in full: status and failure detail, text, schedule and timezone, media, target accounts and networkOptions (first comment, collaborators, privacy… per network). | read-only |
create_post | Create a post for one or more social accounts. | destructive |
update_post | Edit an existing post (typically a draft or a scheduled one): copy, media, target accounts, schedule. | destructive |
validate_post | Dry run: check copy and media against every target network (character limits, media requirements, mandatory options) WITHOUT creating anything. | read-only |
schedule_post | Set the date and time of an existing post. | destructive |
unschedule_post | Unschedule a SCHEDULED (or pending-approval) post: it goes back to DRAFT, keeping its date as a suggestion, and nothing is published. | destructive |
delete_post | Delete a post from Ignix and from the scheduler. | destructive |
unpublish_post | Remove an already published post FROM THE SOCIAL NETWORK. | destructive |
retry_post | Send a failed post to the network again, keeping its content and targets.. | destructive |
duplicate_post | Create a draft copy of an existing post, ready to edit and reschedule.. | writes |
recycle_post | Schedule a copy of any existing post (same text, media and accounts) in the next free slot of the workspace's posting queue, and return the new post and its scheduledFor; it does not check how the original performed. | destructive |
suggest_publish_times | Next free slots in the organization's posting queue, in its timezone. | read-only |
list_pending_approvals | Posts waiting for review when the approval workflow is enabled for this organization.. | read-only |
review_post | Approve a post awaiting review (it is then scheduled or published according to its intent) or reject it back to draft with a reason.. | destructive |
get_network_options | Every option a network accepts in networkOptions when creating a post: key, type, whether it is required, and the exact accepted values (Instagram contentType, YouTube privacy, TikTok consent, Pinterest board…). | read-only |
get_network_choices | Values that only the network can give for a specific account: Pinterest boards, YouTube playlists, the TikTok privacy levels that account actually allows, the Facebook Pages the account manages, and the LinkedIn company pages it administers. | read-only |
get_posting_queue | Read the weekly posting grid of one workspace: each slot with weekday (0 = Sunday), day, hour and minute in the organization timezone. | read-only |
set_posting_queue | REPLACE the weekly grid of recurring slots of ONE workspace (pass workspaceId; other workspaces keep theirs). | destructive |
bulk_create_posts | Create many posts for the same accounts in one call. | destructive |
attach_media_to_post | Add an already hosted image/video URL to a post that exists. | destructive |
suggest_post_idea | Propose a ready-to-publish post idea for a given network, based on the brand and limited to what this organization can actually produce (it will not suggest an AI video if no video provider is configured). | writes |
get_top_posts | Ranking of published posts by engagement in the period, with their metrics, engagement rate and caption. | read-only |
get_posting_cadence | How many posts per week each network gets and the engagement rate at that cadence — the data behind "should we post more or less?".. | read-only |
list_library_posts | Content already published on the networks, INCLUDING posts published natively outside Ignix, with its media. | read-only |
publish_whatsapp_flow | Publish a flow so it can be sent. | destructive |
publish_store_product | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
unpublish_store_product | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
run_autopilot | Run Ignix Autopilot — the same as the Autopilot panel in the calendar. | writes |
list_autopilot_plans | The recurring Autopilot plans of the workspace (the "Repeat" option of Autopilot in the calendar), with their next run, last result and cost.. | read-only |
create_autopilot_plan | Save an Autopilot setup (accounts, ideas per run, period, format, brief) that runs on its own daily, weekly or monthly at 7:00 in the organization's time zone and leaves the content as DRAFTS (the user gets an email each time; nothing is published). | writes |
update_autopilot_plan | Change a plan (planId from list_autopilot_plans); only what you pass changes. | destructive |
activate_autopilot_plan | Turn a plan on so it runs on its schedule and spends AI credits on every run. | writes |
deactivate_autopilot_plan | Pause a plan: it stops running and spending. | writes |
delete_autopilot_plan | Delete a plan. | destructive |
Media and AI content
| Tool | What it does | Access |
|---|---|---|
edit_image | Edit an image you already have: change the background, add or remove an object, restyle it, make a variation. | writes |
generate_image | Generate an image from a text prompt and return a durable public URL ready to pass to create_post as media. | writes |
get_image_quota | AI credits used and left this month (one pool per organization; it renews every month on the organization's billing date and unused credits do not roll over). | read-only |
list_media_providers | Video and avatar-video providers that are wired AND have a key configured by this organization. | read-only |
generate_video | Start an AI video generation job (text-to-video, image-to-video, or an avatar reading a script). | destructive |
get_media_job | Status of a video generation job. | read-only |
list_avatar_options | List the avatars (id, label, thumbnail) and voices (id, label) available in one avatar video provider (HeyGen, Creatify or Synthesia) through the organization's own key. | read-only |
upload_media | Put a file that lives on the user's machine into durable Ignix storage and get back a stable https URL. | writes |
import_media | Download public URLs and re-host them on durable Ignix storage, returning stable URLs usable as post media or as the file of a chatbot flow node. | writes |
list_library_media | Images and videos already generated or uploaded by this organization, newest first. | read-only |
write_caption | Write a post caption from an idea, using this organization's brand voice (business description, tone and knowledge base). | writes |
adapt_caption | Rewrite an existing text in the native style and length of a given network (a LinkedIn post is not an X post). | writes |
translate_caption | Translate a text naturally into another language, keeping tone, emojis and hashtags. | writes |
suggest_hashtags | Up to 5 relevant hashtags for a text, mixing popular and niche ones (few and relevant beats many). | writes |
plan_content | Plan a piece of content end to end: caption plus, for each slide, its idea and a detailed art-directed image prompt with a shared visual style. | writes |
list_sound_effects | The Ignix library of 75 ready-made sound effects for videos (MP3 URLs), free to use: transitions (whooshes, swipes, risers, glitches), UI (clicks, taps, pops, notifications, typing), hits (impacts, booms, sub drops, sparkles), money and wins (cash register, coins, level up), comedy (record scratch, boing, rimshot), crowd (applause, cheers, laughs) and ambient (clock, doorbell, phone vibrating). | read-only |
list_pending_reels | Reels and long YouTube videos that Autopilot planned for this brand and that are waiting for their video ("Reel with Claude", "YouTube video with Claude"): which account, which day, what each one is about and, when Autopilot planned it, how it will look (look: the Ignix Editor blocks and Creator shots of its production treatment; get_reel_playbook returns the full treatment). | read-only |
save_video_plan | For a chat that cannot run commands (web or mobile): once the user has approved the script of a reel or video planned with get_reel_playbook, save it in Ignix so it can be rendered on their computer. | destructive |
get_reel_playbook | Call this ONLY when the user wants a video made: a reel or Short (default), or a long horizontal YouTube video (length "long"). | read-only |
generate_voiceover | Speak ONE line (one sentence, up to 400 characters) and return a WAV file URL with its exact duration. | writes |
generate_sound_effect | Create a NEW short sound effect (up to 4 s) from a description and return a WAV file URL with its duration. | writes |
get_edit_playbook | Returns the step-by-step guide to edit the user's own video (subtitles, hook, zooms, cutting pauses, b-roll) or cut clips from a long one (a live, a podcast, a webinar): transcribe on their machine, decide the edit yourself (free; only what you generate costs credits), build it with Ignix Editor, render, check, leave it as a draft. | read-only |
plan_video_edit | Ignix's video editor, with this brand's context: from the TRANSCRIPT of the user's own video (each word with its times) it decides the hook title, captions and emphasised words, zooms, on-screen texts and numbers, emojis, sound effects from the Ignix library, b-roll from the user's files, cuts (only if asked), the end card, and the post caption with hashtags. | writes |
plan_clips | Ignix's clip editor: from the TRANSCRIPT of a long video (a live, a podcast, a webinar, a talk) grouped in sentences, it picks the moments that work on their own as reels (15-60 s each), ranked, each with start/end seconds, an on-screen hook, a caption and hashtags. | writes |
get_edit_style | The workspace's saved edit style: how the user edits their videos, MEASURED by Ignix Editor on 2–3 of their own videos (cut pace, text on screen, framing and zooms, motion, colour, loudness, speech pace, sound effects) plus what was SEEN in them (typography, captions, kinds of animation, transitions, sound effects, hook, pacing). | read-only |
save_edit_style | Save this workspace's edit style; it REPLACES the one saved before. | destructive |
delete_edit_style | Delete this workspace's saved edit style (when the user asks). | destructive |
search_stock_media | Search free stock footage and photos (Pixabay) for a video or post the user asked for: b-roll for an edit, a clip or image for a reel beat, a background. | read-only |
analyze_reel | One public Instagram reel or post, TikTok or YouTube video by its URL: its numbers, caption and duration (and, for Instagram, a direct video link that expires within hours). | writes |
Appointments
| Tool | What it does | Access |
|---|---|---|
get_booking_settings | How appointments are set up in this workspace: services (duration, buffers, price with its currency, who does them, whether they are charged when booking, where they happen: Google Meet, the business's own video link or in person, and how people count: partyMode "none" = one booking is one spot, "seats" = activities where a booking of N people takes N spots, "tables" = restaurants where each resource is a table type and a booking takes one table that fits the party; with partyMax > 1 ask how many people), people and rooms (hours, days off, spots; for restaurants, spots = how many tables of that type and tableSize = the party sizes it seats), what is asked when booking, the rules (slot step, minimum notice, horizon, reminders, cancellation policy, automatic refund window for paid bookings, review requests, currency), whether Google Calendar is connected, and the public booking page URL. | read-only |
get_booking_availability | Free slots for a service from a given day, honouring hours, days off, spots, buffers and what is already in Google Calendar. | read-only |
create_appointment | Book an appointment on behalf of the business (for example one that came in by phone). | destructive |
list_appointments | Upcoming appointments booked through Ignix (web chat, DM, Sparky, booking page or this MCP). | read-only |
cancel_appointment | Cancel an appointment booked through Ignix by id (from list_appointments). | destructive |
list_booking_reviews | Reviews left by customers after an appointment (stars, text, the service, the business reply, and whether it is hidden from the booking page), newest first, plus the visible average. | read-only |
reply_booking_review | Publish (or replace) the business reply to an appointment review; it shows under the review on the public booking page. | destructive |
set_booking_review_hidden | Hide an appointment review from the public booking page (and from its average), or show it again. | destructive |
set_booking_review_requests | When on, every customer with an email gets a review request by email about an hour after a completed appointment, plus one reminder the next day if they did not answer (appointments that ended more than 3 days ago are not asked). | destructive |
create_booking_service | Add a service customers can book on the public booking page. | writes |
update_booking_service | Change a service (serviceId from get_booking_settings); only the fields you pass change. | destructive |
delete_booking_service | Remove a service from the booking page (serviceId from get_booking_settings). | destructive |
create_booking_resource | Add a person or room that can be booked, with its weekly hours (in the business time zone), days off and spots (customers at the same time: 1 for a person, 6 for a class). | writes |
update_booking_resource | Change a person or room (resourceId from get_booking_settings); only what you pass changes. | destructive |
delete_booking_resource | Remove a person or room and take it off every service (its Google calendar is NOT deleted). | destructive |
update_booking_settings | Change the appointment settings of the workspace; only what you pass changes. | destructive |
Store
| Tool | What it does | Access |
|---|---|---|
get_store | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
list_store_products | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
get_store_product | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
list_store_orders | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
refund_store_order | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
list_coupons | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
create_coupon | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | writes |
set_coupon_active | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
list_members | Subscribers of a membership product: email, name, status (active, past_due while a failed payment is retried, canceled…), price and interval, member since, next renewal and whether they cancelled (keeps access until the end of the paid period). | read-only |
list_store_blocks | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | read-only |
add_store_block | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | writes |
update_store_block | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
delete_store_block | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
show_store_block | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | writes |
hide_store_block | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
reorder_store_blocks | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
update_store_theme | Store administration: works on the business's own link-in-bio store or appointments/bookings landing in Ignix, which the user manages as its owner. | destructive |
create_store_product | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | writes |
update_store_product | Store administration: works on the business's own link-in-bio store in Ignix, which the user manages as its owner. | destructive |
Inbox
| Tool | What it does | Access |
|---|---|---|
suggest_first_comment | Write the first comment to go under a post: the right place for links, an engagement question or extra hashtags. | writes |
list_conversations | List inbox conversations (direct messages from every connected network plus the website chat), each with id, platform, accountId, participant, lastMessageAt, unread, needsHuman, stage, labels and ticketNumber, plus count of all that matched. | read-only |
get_conversation | Message history of a conversation, oldest first, plus its triage state (stage, labels, assignee, ticket priority/subject, whether it waits for a human) and the team's internal notes, which the customer never sees. | read-only |
send_message | Send a message in an existing conversation. | destructive |
start_conversation | Open a direct message with someone who has not written first. | destructive |
update_conversation | Triage a conversation in the inbox, the way an operator does from the app: pipeline stage, labels, assignee (a member or a team, or nobody), ticket priority and subject, mark it read, escalate it to a human (silences the bot on that thread and notifies the team) or mark it handled (clears the escalation and lets the bot answer this contact again). | destructive |
add_conversation_note | Leave a private note on a conversation for the team (context, what was promised, what to check). | writes |
list_comments | Published posts that have comments, newest first. | read-only |
get_comment_thread | Comments on a published post, with author and text, replies included (each reply has replyTo, the comment it answers). | read-only |
reply_to_comment | Reply publicly to a comment, or send a private direct message to its author (private: true, Instagram and Facebook only, within 7 days of the comment). | destructive |
moderate_comment | Hide one comment from the public on a published post, or show it again with hidden: false. | destructive |
list_reviews | List reviews from Google Business Profile and the other networks that have them, up to 40, each with id, platform, accountId, rating, text (first 500 characters), author, date and answered. | read-only |
reply_to_review | Publish the business's public reply to one review (reviewId from list_reviews), shown under the review on Google or the network. | destructive |
list_tickets | List support tickets: inbox conversations that were turned into a ticket with create_ticket. | read-only |
list_saved_replies | Canned replies the team has saved. | read-only |
preview_automation | Read a flow the way a customer would experience it: the sequence of messages, buttons and branches. | read-only |
create_ticket | Promote a conversation to a support ticket, with number, subject and priority, so it stops living only in the inbox. | destructive |
create_comment_to_dm | From here, Instagram and Facebook only (VK communities have comment-to-private-message too, but it is set up by a person in the Ignix app: Automations): when someone comments a keyword on a post (or replies to a story), the connected account automatically sends that person one private reply with what they asked for. | destructive |
list_welcome_messages | List the welcome messages of the workspace (the automatic reply an account sends the first time someone writes to it), each with id, message and active; the answer does not say which account each one belongs to. | read-only |
create_welcome_message | Create the message one account sends automatically to each person the first time they write to it, and return its id and whether it is active. | destructive |
update_welcome_message | Replace the text of a welcome message (welcomeId from list_welcome_messages).. | destructive |
set_welcome_message_active | Turn a welcome message on (active: true) or off (active: false). | destructive |
delete_welcome_message | Delete a welcome message (welcomeId from list_welcome_messages). | destructive |
list_mentions | Mentions found outside the organization's own posts, by its saved searches on X and in the news, newest first. | read-only |
reply_to_mention | Reply on the network to a mention found by a saved search. | destructive |
get_message_usage | The organization's DM quota for the current billing period: every private message sent counts (automation replies, manual inbox replies, comment-to-DM, each broadcast recipient and each sequence step per contact); comments, reviews, web chat, email and X do not. | read-only |
preview_whatsapp_flow | Get a previewUrl that opens the WhatsApp Flow in a browser exactly as a customer would see it, to check it with the user before publishing. | read-only |
Contacts
| Tool | What it does | Access |
|---|---|---|
list_contacts | List and filter the CRM contacts (people who have written to or interacted with the connected accounts), each with id, name, email, tags, subscribed and platform, plus count with the total that matched before the limit. | read-only |
get_contact | Full detail of a contact: channels they use, tags, custom fields, notes and last interaction.. | read-only |
create_contact | Add a person to the CRM by hand (people who write to the accounts are added on their own) and return the created contact with its id. | writes |
update_contact | Edit a contact: name, email, company, notes, tags, subscription or blocked state, or pause the bot for them. | destructive |
set_contact_field | Write a value into one of the custom fields defined for this organization (list them with list_custom_fields).. | destructive |
list_custom_fields | List the custom fields defined for contacts (extra data such as birthday, city or plan), each with name, slug, type (text, number, date, boolean or select) and, for select, its options. | read-only |
create_custom_field | Define a new custom field for contacts (text, number, date, boolean yes/no, or select with a list of options) so the bot and the team can store a value per person. | writes |
send_welcome_to_existing_contacts | A welcome message only reaches NEW contacts. | destructive |
Automations
| Tool | What it does | Access |
|---|---|---|
get_automation_usage | How many times each chatbot flow ran in the period, and which are active. | read-only |
list_automations | List the chatbot automation flows (comment-to-DM, keyword replies, welcome flows…), each with id, name, active, trigger, platforms, accountIds, totalRuns and updatedAt. | read-only |
get_automation | Detail of a flow, including its node graph — useful to explain what the bot answers and where it escalates to a human. | read-only |
set_automation_active | Enable or disable an automation flow. | destructive |
list_broadcasts | List the broadcasts (one message sent to many contacts at once) of the workspace, up to 40, each with its _id, name, platform, accountId, status (draft, scheduled, sending, sent, cancelled or failed), scheduledAt and delivery counts (recipients, sent, delivered, read, failed) when the network reports them. | read-only |
list_sequences | List the drip sequences (messages sent to one contact step by step over days), up to 40, each with _id, name, platform, accountId, status (draft, active or paused), its steps with delays and text, enrollmentCount and whether it stops when the contact replies or unsubscribes. | read-only |
search_knowledge | Semantic search over everything this business has taught its AI: website, uploaded documents, social posts, manual notes. | read-only |
get_brand_profile | How this business describes itself and how its AI should sound: WHO SPEAKS (the company, a person or a character), business name, description, tone, agent name, standing instructions, which knowledge sources are loaded, and what it can DELIVER to a customer by DM. | read-only |
learn_brand_style | Re-reads the posts this workspace's accounts have already published and updates the posting style returned by get_brand_profile: brand colours with their role, how the posts are built, and how the brand writes on each network. | destructive |
list_catalog | List the products and services the Ignix assistant can offer customers in chats, each with id, name, description, price (as shown to customers), url, imageUrl, category, available and needsReview (read from the website and not yet confirmed, so not offered). | read-only |
get_automation_node_types | The FULL specification of every node and trigger a flow can use: what each one does, its exact fields with types and accepted values, its outputs (which branch goes where), and whether the chosen accounts support it. | read-only |
list_automation_templates | Ready-made flows (welcome menu, lead capture, qualify and hand off, follower gate, comment coupon, drip opt-in), each with the COMPLETE graph it would build and the trigger it would use. | read-only |
create_automation_from_template | Instantiate a template as a new flow, adapted to this business. | writes |
create_automation | Create a chatbot flow for the connected accounts. | writes |
update_automation | Edit a flow: name, trigger, target accounts or the whole node graph. | destructive |
duplicate_automation | Copy an existing flow, graph and all, so you only have to change what differs — typically the keyword and the post. | writes |
share_automation | Create (or return) a private link to one of the user's own flows. | writes |
unshare_automation | Turn off the private share link that share_automation made for one of the user's automations, so nobody else can import it from that link. | destructive |
import_shared_automation | Add a copy of an automation another Ignix account shared (a link like https://app.ignix.social/app/automations/shared/…) to this workspace. | writes |
submit_automation_to_gallery | Send one of the user's own flows for review so every Ignix client can use it from Templates and from a public page on the Ignix website, credited to their brand. | destructive |
delete_automation | Delete a flow permanently. | destructive |
create_broadcast | Create a mass message to the CRM contacts of one account. | destructive |
send_broadcast | Send a broadcast NOW to every recipient. | destructive |
cancel_broadcast | Cancel a scheduled broadcast, or delete it entirely with remove: true.. | destructive |
create_sequence | Create a timed message sequence (drip) for the subscribers of one account: each step goes out after its delay, and it stops for anyone who unsubscribes. | writes |
activate_sequence | Turn a drip sequence on: enrolled contacts start receiving its messages at their delays. | destructive |
pause_sequence | Pause a drip sequence: no more of its messages go out until it is activated again. | writes |
delete_sequence | Delete a drip sequence and stop it for everyone enrolled. | destructive |
enroll_in_sequence | Enroll a SEGMENT of subscribed contacts in a drip sequence: those carrying the given tags, or every subscriber of that account if no tag is given. | destructive |
unenroll_from_sequence | Stop a drip sequence for ONE contact: they receive no further steps of it (what was already sent stays sent). | destructive |
teach_knowledge | Add text to this workspace's knowledge base: a policy, an FAQ, prices, how a process works. | destructive |
create_catalog_item | Add a product or service to the catalogue the Ignix assistant uses to answer customers. | writes |
update_catalog_item | Change a catalogue item (itemId from list_catalog). | destructive |
delete_catalog_item | Remove a catalogue item (itemId from list_catalog). | destructive |
confirm_catalog_items | Items read from the website arrive UNCONFIRMED (needsReview: true in list_catalog) and the assistant does not offer them until they are confirmed. | destructive |
list_quick_automations | The simple automations built without the flow editor: someone comments a keyword and gets a direct message, or replies to a story and the bot answers.. | read-only |
get_bot_setup | Read the shortcuts a customer sees before writing to one account: the persistent menu on Facebook (title, web_url or postback), the iceBreakers on Instagram (question and payload) or the bot commands on Telegram. | read-only |
set_bot_starters | Configure what a customer sees before writing: the persistent menu on Facebook (up to 3 entries) or the ice breakers on Instagram (up to 4 questions). | destructive |
get_brand_sentiment | INFERNO ONLY. | read-only |
get_brand_memory | The lasting rules the owner has set for this workspace's content — whoever speaks there: a brand, a person or a character (see speaker in get_brand_profile) — target audience, content tone, preferred call to action and comment keyword, visual direction, positioning, things to never say, terminology, offers, goals, content preferences — each with where it came from. | read-only |
remember_brand_fact | Save ONE lasting rule the owner stated for this workspace's content — whether it speaks as a brand, a person or a character (e.g. | destructive |
forget_brand_fact | Delete one brand rule from this workspace by its id (from get_brand_memory). | destructive |
update_brand_profile | Change fields of this workspace's brand profile (Sparky AI > Knowledge): what Sparky — the AI agent that answers customers in DMs, comments and web chat — knows about the business and how it speaks, and what content generation uses as the brand's description, audience and words to avoid. | destructive |
refresh_knowledge | Re-read the websites in this workspace's brand profile (main website + extra pages) and the style of its social accounts, now, in the background, so Sparky answers with what the site says today. | destructive |
list_knowledge_sources | Every source Sparky has learned from in this workspace — uploaded files, the websites, the social accounts' style, the brand profile, text taught with teach_knowledge — with how many passages each one has and since when. | read-only |
get_knowledge_source | The text Sparky learned from one source (an uploaded file, the websites, a taught text…), passage by passage in the order it was learned, up to 50 passages. | read-only |
delete_knowledge_source | Delete every passage Sparky learned from one source (an uploaded file, the websites, the social style, a taught text), so it really stops knowing it. | destructive |
list_dm_resources | The deliverables of this workspace: the guide, template, file or link a DM sends when someone asks for it or comments a keyword. | read-only |
create_dm_resource | Add a deliverable a DM can send (a guide, template, file or link) — what a keyword call to action may promise. | writes |
update_dm_resource | Change a deliverable (resourceId from list_dm_resources); only what you pass changes. | destructive |
delete_dm_resource | Delete a deliverable (resourceId from list_dm_resources). | destructive |
list_routing_rules | The rules that decide who takes over a conversation the assistant hands to a human, by topic, with their id, topic and assignee.. | read-only |
create_routing_rule | Add a topic ("Billing", "Wholesale orders"…) and who gets those conversations when a handoff is set to assign automatically: the AI classifies the conversation into one of these topics and assigns it to the rule's person (assignUserId) or team (assignTeamId), both from list_team. | writes |
update_routing_rule | Change a rule (ruleId from list_routing_rules); only what you pass changes. | destructive |
delete_routing_rule | Delete a rule (ruleId from list_routing_rules). | destructive |
update_brand_style | Hand-edit the posting style Ignix learned from the brand's published posts — the writing VOICE (how it writes captions) and/or the VISUAL guide (colours with their role, layout, typography, treatment, recurring elements, what to avoid) — for the whole workspace (scope 'general') or for one account (scope 'account' + accountId). | destructive |
Analytics and listening
| Tool | What it does | Access |
|---|---|---|
get_analytics | Aggregated performance for the period: totals per metric (impressions, reach, likes, comments, shares, saves, followers…), the same totals for the previous period so you can state growth, and a per-network breakdown. | read-only |
get_best_times | Weekday × hour engagement grid built from this organization's own history, in its timezone. | read-only |
get_follower_growth | Follower evolution per account and in total, from the daily snapshots Ignix stores. | read-only |
get_engagement_trend | Daily engagement and impressions over the period, plus whether the second half is doing better or worse than the first. | read-only |
get_audience | Read audience demographics of one Instagram or YouTube account: age, gender, top 10 countries and top 10 cities, each as label and value, sorted. | read-only |
get_inbox_analytics | Measure messaging performance over a window (default 30 days): messages received and sent, how many were answered by automation and its percentage, conversations, unread count, and average and median response time in seconds. | read-only |
list_saved_searches | List every saved search that watches for mentions of the brand, a competitor or a topic on X and in the news, oldest first, paused ones included: id, name, network, query, kind, active (false when paused) and how many mentions it has found, plus how many searches the plan allows (used/limit). | read-only |
create_saved_search | Watch for mentions of the brand (or a competitor, or a topic) on X or in the NEWS (press and blogs via Google News; the brand's own website is left out). | writes |
pause_saved_search | Stop checking a saved search (id from list_saved_searches) without deleting it.. | writes |
resume_saved_search | Start checking a paused saved search again (id from list_saved_searches).. | writes |
delete_saved_search | Delete a saved search (id from list_saved_searches) together with every mention it found: they disappear from list_mentions for good, while replies already posted stay on the network. | destructive |
build_report_link | Link to the analytics report laid out as a document — cover, executive summary and one section per page — ready to save as PDF from the browser. | read-only |
get_x_usage | X is the only network billed per use, so X actions spend from a monthly pool of Ignix credits (1 credit = 1 cent): every connected X account brings a free allowance on every plan, X seats add more, and when the pool is empty EVERYTHING on X that costs credits pauses until next month or a new seat — posting, links, DMs, listening and comment automations. | read-only |
research_niche | What is working in the user's niche right now, from a few words for the topic (from get_brand_profile: the topic or type of business; the city only for a local business). | writes |
list_research | The analyses this brand already ran (niche on Instagram, YouTube, Reddit or X, an account, a reel), newest first, the same ones the app shows under Trends → Niche research and Account research: id, what was analysed, network and date. | read-only |
get_research | The full result of an analysis this brand already ran (from list_research), exactly as it came out that day: niche reels and accounts, subreddits with their rules and top posts, an account's pieces, a reel. | read-only |
Google Business, WhatsApp and web chat
| Tool | What it does | Access |
|---|---|---|
list_whatsapp_templates | Message templates approved by WhatsApp for an account, with their status. | read-only |
get_reputation_alerts | The current reputation rules: sentiment analysis on or off, the negative-spike alert, the review alert and automatic review replies, and which team receives them.. | read-only |
update_reputation_alerts | Change the reputation rules; only the fields you pass change. | destructive |
create_whatsapp_template | Submit a WhatsApp message template to Meta for approval. | writes |
delete_whatsapp_template | Delete a WhatsApp template by name (see list_whatsapp_templates). | destructive |
get_whatsapp_profile | Read the business profile customers see on one WhatsApp Business account: about line, description, email, websites, address, vertical (business category) and the profile picture URL. | read-only |
update_whatsapp_profile | Change the business card customers see on WhatsApp; only the fields you pass change, and empty values are ignored (nothing is cleared from here). | destructive |
list_whatsapp_flows | The WhatsApp Flows of an account (forms that open inside WhatsApp: booking, qualifying, ordering) with their id and status. | read-only |
create_whatsapp_flow | Create a WhatsApp Flow as a draft. | writes |
upload_whatsapp_flow_json | Upload (replace) the Flow JSON of a draft flow, in Meta's Flow JSON format. | destructive |
deprecate_whatsapp_flow | Deprecate a published flow so it can no longer be sent. | destructive |
delete_whatsapp_flow | Delete a draft flow. | destructive |
send_whatsapp_flow | Send a PUBLISHED flow to one phone number, as a message with a button that opens it. | destructive |
get_whatsapp_flow_responses | Read what people submitted through one WhatsApp Flow: up to the latest 100 responses, each with id, receivedAt, from (phone), senderName, conversationId and data (the form fields as the flow defines them). | read-only |
get_gbp_listing | Everything on the business listing: its locations, the details (description, website, phone), the attributes Google offers for that category, the services, the booking/order links and the food menu. | read-only |
update_gbp_listing | Change the description, website or phone, and switch on or off the boolean attributes Google offers for that category (wheelchair access, outdoor seating, delivery…). | destructive |
list_gbp_photos | List the photos on a Google Business listing (videos are left out), each with mediaId, url, category (cover, logo, interior, product…) and caption. | read-only |
add_gbp_photo | Add a photo to the Google Business listing from a public https URL, in a category (cover, logo, interior, product…). | writes |
remove_gbp_photo | Remove a photo from the listing (mediaId from list_gbp_photos). | destructive |
replace_gbp_services | Replace the WHOLE service list of the listing, in Google structured-service format. | destructive |
replace_gbp_food_menus | Replace the WHOLE food menu of the listing, in Google food-menu format. | destructive |
create_gbp_action_link | Add an action link to the listing (book, order, reserve, shop online…) with its destination URL. | writes |
update_gbp_action_link | Change the destination URL or the type of an existing action link on the Google Business listing (the Book, Order or Reserve buttons). | destructive |
delete_gbp_action_link | Remove an action link from the listing (name from get_gbp_listing). | destructive |
get_gbp_verification_status | Check whether a Google Business listing is verified: voiceOfMerchantState (whether the owner has control and whether a verification is pending) and the list of verifications with method, state (PENDING, COMPLETED or FAILED) and date. | read-only |
list_gbp_verification_options | The verification methods Google allows for this location (postcard, phone call, SMS, email…).. | read-only |
start_gbp_verification | Ask Google to send a verification code by one of the allowed methods (from list_gbp_verification_options). | destructive |
get_web_chat | Read the web chat bubble the customer embeds on their own website: whether it is on, title, greeting, agent name, colours, logo, pre-chat form, alert email, starters, quick links and AI/privacy links, its placement (side, offsets, hidden paths, mobile), the allowedDomains, and the snippet (one script tag) to paste once into the site. | read-only |
set_web_chat_placement | Move or hide the chat bubble on the customer's website so it stops covering their cart, cookie bar or another floating button. | destructive |
update_web_chat | Change what visitors of the customer's website see in the chat: on/off, title, greeting, agent name, subtitle, colours, logo, pre-chat form, email alerts, conversation starters, satisfaction rating, live-visitor tracking, quick links, AI-notice and privacy links, and placement. | destructive |
Team
| Tool | What it does | Access |
|---|---|---|
get_connect_url | Return a link the human can open to connect a new social account, or to reconnect one whose token expired. | writes |
list_connect_links | The client connect links (get_connect_url with for_client) of this workspace that are still active: who each one is for, when it was created, when it expires, when it was last used and how many accounts were connected with it. | read-only |
revoke_connect_link | Revoke a client connect link so it stops working at once (accounts already connected with it stay connected). | destructive |
list_writing_assets | Hashtag sets and reusable text snippets the team has saved. | read-only |
save_writing_asset | Save a reusable hashtag group or text snippet (a signature, a disclaimer, a recurring call to action) for this workspace and return its id. | writes |
retweet_on_x | Retweet a post (tweetId) from a connected X account, or undo the retweet with undo: true. | destructive |
bookmark_on_x | Bookmark a post (tweetId) from a connected X account, or remove the bookmark with undo: true. | destructive |
follow_on_x | Follow an account (targetUserId) from a connected X account, or unfollow with undo: true. | destructive |
list_team | Who is in this organization, with their role, plus the sub-teams and the pending invitations. | read-only |
Everything else
| Tool | What it does | Access |
|---|---|---|
get_working_rules | The full rules for working with Ignix that do not fit in the server instructions: confirmations, Ignix Editor on the user's computer, media uploads, links and buttons, automations that wait for the next post, appointments and paid bookings, and the store. | read-only |
confirm_spend | Runs what a quote was for, after the user said yes: a tool that spends AI credits first answers with needsConfirmation, the credits and a confirmToken; once the user agrees, call this with that confirmToken (or call the tool again with the same arguments and confirm: true). | destructive |
get_editor_license | Ignix Editor only works for Ignix customers with an active plan. | read-only |
get_creator_setup | How to install, sign in and connect Ignix Creator (generation on the user's computer or on Cloud Boost: talking presenters from a photo, photo → video, text → video, scenes made from their own photos (people, product, place) with their voices, first-to-last-frame shots, long takes and clips up to 15 s, transforming one of their videos — the person, the place, an object or the voice —, dubbing) at the exact version Ignix supports. | read-only |
list_style_examples | List the style material the customer supplied from accounts that are not connected to Ignix (captions, transcripts, images), with each example's id. | read-only |
add_style_examples | Add style material the customer supplies from accounts that are not connected to Ignix: captions, video transcripts or scripts, or images of real posts from their old TikTok, another brand of theirs, anything they want the style learned from. | writes |
delete_style_examples | Delete one style example (id from list_style_examples), or every example of a destination with all: true. | destructive |
import_style_from_link | Learn a writing (and, on Instagram, visual) style from a PUBLIC Instagram, TikTok or YouTube profile: the customer's own account that is not connected, or one they want to take inspiration from (the style keeps tone and form, never sentences). | destructive |
get_style_import_status | Progress and result of an import started with import_style_from_link. | read-only |
create_reply_template | Save a reply the team can reuse in the inbox (see list_saved_replies). | writes |
update_reply_template | Change the title and/or text of a saved reply (replyId from list_saved_replies). | destructive |
delete_reply_template | Delete a saved reply (replyId from list_saved_replies). | destructive |
list_agenda | Everything that goes out from now on (scheduled posts, drafts with a date and posts waiting for approval) for the next days, plus the tasks and meetings. | read-only |
create_agenda_item | Add a task (something to do by a date, e.g. | destructive |
update_agenda_item | Change a task or meeting by id (from list_agenda): only what you pass changes. | destructive |
get_agenda_item | One task or meeting by id (from list_agenda), with its files: the references the agency attached (role "reference") and the takes the creator delivered (role "delivery"), each with a public URL you can use in a post, plus the shared folder link of its client if there is one.. | read-only |
add_agenda_file | Attach an image, video or audio that is already online (a public URL) to a task: role "reference" for what the agency sends (e.g. | writes |
set_agenda_client | How a client (workspace) shows in the agenda: a 2-3 letter tag, a colour (#rrggbb) and the link of a folder shared with that client (Google Drive, Dropbox…; https only, empty string removes it). | destructive |
delete_agenda_item | Delete a task or meeting by id. | destructive |
list_characters | The people, characters and PLACES of this workspace besides the one it speaks as (that one is speaker in get_brand_profile): each with its name, its kind (person = a real person, character = an invented one, place = one of the business's own premises), a short note of how it looks, what it wears (outfit, people and characters only), how many reference photos it has, and sheet: the canonical text of its sheet. | read-only |
list_my_voices | The user's own cloned voices in this workspace (recorded by them in Ignix → Sparky AI → Voice, with their spoken consent). | read-only |
plan_campaign | Plan a run of content the way Autopilot does — WITHOUT creating anything — so you can go through it with the user and change it first. | writes |
get_creative_direction | The choices of this account's last approved videos (up to 20, oldest first): structure (story with a turn, before/after, list with a payoff), the demo shown, opening, layout, motion, captions, transitions and catalog pieces. | read-only |
record_creative_direction | Save the visual choices of a video ONLY AFTER the user approved its storyboard: approved: true, a stable project (the video's folder name) and what was actually chosen — structure, demo (the feature, screen or result shown), style (the slug of the catalog look, when one was used), opening, layout, motion, captions, transitions (short phrases) and pieces (catalog/block names). | destructive |
get_shot_guide | Free. | read-only |