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

# AI agent tools

> Every tool a connected AI agent can use, who can use it and what it changes.

This is every tool an AI agent connected to InstaForge can use, grouped by area. An agent acts as you: it can only use a tool your role allows, and a read-only connection only the tools marked **Reads**. See [AI agents](https://docs.instaforge.app/running-the-agency/ai-agents.md) for connecting one.

**Reads** looks and changes nothing. **Changes** saves something. **Asks first**: the agent is told to show you what it will do and wait for your yes (deleting, sending to customers, publishing, paying). That last one is guidance to the agent; what your role allows is enforced by the server.

Never through an agent: passwords, two-step sign-in, API keys and tokens (they're pasted in the dashboard), making someone an admin of your agency or changing one, and uploading files.

## Getting started

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `whoami` | Shows who you are signed in as, your role and your agency's limits. | All roles | Reads |
| `read_guide` | Reads a short guide on how InstaForge works and how to do common jobs. | All roles | Reads |
| `agency_overview` | Shows what needs someone now across the agency, and what's coming up. | All roles | Reads |

## Clients and assistants

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `list_bots` | Lists the assistants you can see, with their status. | All roles | Reads |
| `get_bot` | Shows one assistant in full: settings, rules, flows and knowledge size. | All roles | Reads |
| `create_bot` | Creates a new client with its first assistant, as a draft. | Admin, Editor | Changes |
| `update_bot_settings` | Changes an assistant's settings, only the ones you name. | Admin, Editor | Changes |
| `set_bot_status` | Sets an assistant live, paused or back to draft. | Admin, Editor | Asks first |
| `delete_bot` | Deletes an assistant and everything in it for good. | Admin, Editor | Asks first |
| `list_clients` | Lists the agency's clients, each with its assistants. | All roles | Reads |
| `get_client` | Shows one client and its assistants. | All roles | Reads |
| `add_assistant` | Adds another assistant to a client, for a second account or branch. | Admin, Editor | Changes |
| `onboard_client` | Sets up a new client in one step: assistant, portal, plan and owner's login. | Admin, Editor | Changes |
| `update_client` | Changes a client's name, shared inbox and which assistant takes bookings. | Admin, Editor | Changes |
| `delete_client` | Deletes a client with all its assistants and their data. | Admin, Editor | Asks first |
| `list_templates` | Lists starting templates for common businesses. | All roles | Reads |
| `clone_bot` | Copies an assistant as a starting point for another client. | Admin, Editor | Changes |
| `quick_setup_draft` | Drafts knowledge, FAQ, welcome and services from the business's website or notes. | Admin, Editor | Changes |
| `quick_setup_result` | Shows the result of a quick-setup draft. | Admin, Editor | Reads |
| `client_intake` | Shows or makes the intake form link the business fills in itself. | Admin, Editor | Changes |
| `quick_setup_apply` | Applies the parts of a quick-setup draft the person agreed to. | Admin, Editor | Changes |
| `autopilot_estimate` | Estimates the most an autopilot run can cost, spending nothing. | Admin, Editor | Reads |
| `autopilot_start` | Builds the whole assistant from the website and Instagram, then tests it. | Admin, Editor | Asks first |
| `autopilot_status` | Shows an autopilot run: progress, what was built and the self-test. | Admin, Editor | Reads |
| `autopilot_apply` | Keeps an approved autopilot draft and saves a version. | Admin, Editor | Asks first |
| `autopilot_discard` | Throws away an autopilot draft and everything it created. | Admin, Editor | Asks first |
| `autopilot_fix` | Applies the suggested fix for a failed self-test question. | Admin, Editor | Changes |
| `autopilot_retest` | Asks the self-test questions again, for example after a fix. | Admin, Editor | Changes |
| `portal_settings` | Shows what the business owner sees in their portal. | All roles | Reads |
| `set_portal` | Changes what the client portal shows and allows. | Admin, Editor | Changes |
| `list_builds` | Lists exports of the assistant as a standalone project. | All roles | Reads |
| `build_project` | Exports the assistant as a standalone Docker project. | Admin, Editor | Changes |
| `bulk_change` | Makes one change on many assistants at once, after a preview. | Admin, Editor | Asks first |

## Knowledge

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `add_knowledge` | Adds pasted text to the knowledge, with AI-written FAQ if you like. | Admin, Editor | Changes |
| `add_faq` | Adds one FAQ: a question with its exact answer. | Admin, Editor | Changes |
| `list_knowledge` | Lists the knowledge entries: FAQ and text. | All roles | Reads |
| `get_knowledge_entry` | Shows one knowledge entry in full. | All roles | Reads |
| `update_knowledge_entry` | Changes one knowledge entry in place, such as a new price. | Admin, Editor | Changes |
| `search_knowledge` | Shows which knowledge the assistant would use to answer a question. | All roles | Reads |
| `knowledge_conflicts` | Lists what the knowledge gives two different values for, with the words that state each. | All roles | Reads |
| `delete_knowledge_entry` | Deletes one knowledge entry. | Admin, Editor | Asks first |
| `delete_knowledge_entries` | Deletes many knowledge entries at once. | Admin, Editor | Asks first |
| `list_unanswered` | Lists questions the assistant couldn't answer, most asked first. | All roles | Reads |
| `answer_unanswered` | Turns an unanswered question into an FAQ, and can send the answer to askers. | Admin, Editor, Client | Asks first |
| `related_unanswered` | Finds other open questions one answer might also cover. | All roles | Reads |
| `dismiss_unanswered` | Hides a question that needs no answer, such as spam. | Admin, Editor, Client | Changes |
| `correct_reply` | Corrects one of the assistant's replies, and the right answer becomes an FAQ. | Admin, Editor, Client | Asks first |
| `list_suggestions` | Lists changes the business owner asked for in their portal. | All roles | Reads |
| `resolve_suggestion` | Marks an owner's change request done or dismissed. | Admin, Editor | Changes |
| `answers_to_approve` | Lists answers the assistant drafted overnight for the team to approve. | All roles | Reads |
| `approve_answer` | Approves an answer from the morning list as an FAQ. | Admin, Editor, Client | Asks first |
| `skip_answer` | Takes an item off the morning list without changing anything. | Admin, Editor, Client | Changes |
| `build_answers_to_approve` | Makes the morning list of answers to approve now. | Admin, Editor | Changes |
| `set_website_check` | Sets the website read weekly to spot changed prices or hours. | Admin, Editor | Changes |
| `list_knowledge_sources` | Lists where the knowledge came from and each source's status. | All roles | Reads |
| `get_knowledge_source` | Shows the full text of one knowledge source. | All roles | Reads |
| `import_website` | Reads the business's website into the knowledge. | Admin, Editor | Changes |
| `reprocess_knowledge_source` | Builds a knowledge source's entries again from its text. | Admin, Editor | Changes |
| `delete_knowledge_source` | Deletes a knowledge source and every entry made from it. | Admin, Editor | Asks first |
| `reopen_unanswered` | Puts a dismissed or answered question back on the open list. | Admin, Editor, Client | Changes |
| `delete_unanswered` | Deletes a question from the unanswered list for good. | Admin, Editor, Client | Asks first |

## Behaviour, flows and languages

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `list_rules` | Lists the assistant's behaviour rules. | All roles | Reads |
| `add_rule` | Adds a rule: when something happens, what the assistant does. | Admin, Editor | Changes |
| `rule_conflicts` | Shows where a behaviour rule keeps a flow from starting, or starts a flow that is gone or switched off. | All roles | Reads |
| `update_rule` | Changes a behaviour rule. | Admin, Editor | Changes |
| `delete_rule` | Deletes a behaviour rule. | Admin, Editor | Asks first |
| `list_flows` | Lists the assistant's flows and the ready-made starters. | All roles | Reads |
| `get_flow` | Shows one flow whole, a short map of its steps, or only the steps asked for, with how people went through them. | All roles | Reads |
| `save_flow` | Creates or changes a flow. | Admin, Editor, Client | Changes |
| `edit_flow` | Changes part of a flow: a text in one language, a step, a branch or a connection. | Admin, Editor, Client | Changes |
| `delete_flow` | Deletes a flow and the answers collected with it. | Admin, Editor, Client | Asks first |
| `set_welcome` | Sets the welcome message and the Instagram starter questions. | Admin, Editor | Changes |
| `sync_ice_breakers` | Sends the starter questions to Instagram. | Admin, Editor | Changes |
| `answer_hours` | Shows night and weekend mode: when the assistant answers. | All roles | Reads |
| `set_answer_hours` | Sets when the assistant answers: always or outside the team's hours. | Admin, Editor | Changes |
| `translation_gaps` | Shows which of the assistant's texts each language is missing. | Admin, Editor | Reads |
| `translate_missing` | Drafts translations for missing languages, saving nothing. | Admin, Editor | Changes |
| `save_translations` | Saves approved translations into empty languages. | Admin, Editor | Changes |
| `list_message_templates` | Lists the message templates of a client or the agency's library. | All roles | Reads |
| `save_message_template` | Creates or replaces a message template. | Admin, Editor, Client | Changes |
| `delete_message_template` | Deletes a message template. | Admin, Editor, Client | Asks first |
| `whatsapp_templates` | Imports, submits for approval or checks WhatsApp templates. | Admin, Editor, Client | Asks first |
| `get_message_template` | Shows one message template in full, in every language. | All roles | Reads |

## Testing and quality

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `test_bot` | Sends a test message as a pretend customer and shows the reply. | Admin, Editor, Agent, Client | Changes |
| `test_conversation` | Sends several test messages in a row in one chat and shows each reply. | Admin, Editor, Agent, Client | Changes |
| `reset_test_chat` | Starts a test chat over, as a brand-new customer. | Admin, Editor, Agent, Client | Changes |
| `list_versions` | Lists the assistant's change history, newest first. | All roles | Reads |
| `restore_version` | Brings the whole set-up, knowledge included, back to an earlier version. | Admin, Editor | Changes |
| `version_changes` | Shows what one version in the history changed. | All roles | Reads |
| `undo_version` | Takes back only what one version changed, keeping later changes. | Admin, Editor | Changes |
| `quality_check` | Shows the weekly quality check and its proposed fixes. | All roles | Reads |
| `run_quality_check` | Checks the last 7 days of conversations now. | Admin, Editor, Client | Changes |
| `apply_quality_fix` | Approves a quality fix, which becomes an FAQ. | Admin, Editor, Client | Changes |
| `dismiss_quality_finding` | Marks a quality finding as not a problem. | Admin, Editor, Client | Changes |
| `publishing_status` | Shows which version customers get and what isn't published yet. | All roles | Reads |
| `set_draft_mode` | Turns draft and publish on or off. | Admin, Editor | Asks first |
| `publish_changes` | Publishes the draft so customers get it. | Admin, Editor | Asks first |
| `list_answer_tests` | Lists the answer tests and how the last run went. | All roles | Reads |
| `add_answer_test` | Pins a question with what its answer must say. | Admin, Editor | Changes |
| `delete_answer_test` | Removes an answer test. | Admin, Editor | Asks first |
| `run_answer_tests` | Runs all answer tests now. | Admin, Editor | Changes |
| `channel_check` | Checks that channels, AI and replies work, or shows the last check. | All roles | Changes |
| `chat_ratings` | Shows customers' answers to the 'did this help?' question. | All roles | Reads |
| `set_chat_ratings` | Turns the 'did this help?' question after chats on or off. | Admin, Editor | Changes |
| `test_connection` | Checks one connection now: AI, payments, Google Sheets or the team's Telegram. | Admin, Editor | Changes |
| `update_answer_test` | Changes an answer test. | Admin, Editor | Changes |
| `discard_draft` | Throws away unpublished changes in draft mode. | Admin, Editor | Asks first |
| `roll_back_published` | Puts customers back on an earlier published version. | Admin, Editor | Asks first |
| `get_version` | Shows what one version in the history held. | All roles | Reads |

## Conversations and customers

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `list_conversations` | Lists people who wrote, those waiting for the team first. | All roles | Reads |
| `get_conversation` | Shows one person's chat, what the assistant remembers and their answers. | All roles | Reads |
| `suggest_reply` | Drafts a reply to someone from the chat and the knowledge, without sending it. | Admin, Editor, Agent, Client | Changes |
| `handoff_summary` | Sums up in a few lines what a person wants, for the team. | Admin, Editor, Agent, Client | Changes |
| `draft_proposal` | Turns short notes about an offer into a message in the business's style. | Admin, Editor, Agent, Client | Changes |
| `reply_to_person` | Sends a message to a person as a team member. | Admin, Editor, Agent, Client | Asks first |
| `list_customers` | Lists customers with their contact details, visits, tags and notes. | All roles | Reads |
| `update_customer` | Saves the team's notes, tags and important dates for a customer. | Admin, Editor, Agent, Client | Changes |
| `morning_brief` | Shows today's morning brief: dates due, with AI drafts to send. | All roles | Reads |
| `brief_action` | Sends a morning-brief message to the customer, or skips it. | Admin, Editor, Agent, Client | Asks first |
| `set_morning_brief` | Turns the morning brief on or off and sets what it brings up. | Admin, Editor | Changes |
| `list_leads` | Shows the lead board by stage, with notes and reminders. | All roles | Reads |
| `update_lead` | Moves a lead, edits its notes or sets a reminder. | Admin, Editor, Agent, Client | Changes |
| `whats_new` | Shows unread chats, people waiting for the team and new leads. | All roles | Reads |
| `list_saved_replies` | Lists the team's saved replies. | All roles | Reads |
| `save_saved_reply` | Adds or changes a saved reply. | Admin, Editor, Agent, Client | Changes |
| `delete_saved_reply` | Deletes a saved reply. | Admin, Editor, Agent, Client | Asks first |
| `assign_conversation` | Gives a conversation to a team member, or takes it off them. | Admin, Editor, Agent, Client | Changes |
| `translate_conversation` | Translates a customer's messages into a team language. | All roles | Changes |
| `translate_reply` | Translates the team's reply into the customer's language, without sending it. | Admin, Editor, Agent, Client | Changes |
| `run_morning_brief` | Makes today's morning brief now. | Admin, Editor | Changes |

## Broadcasts, campaigns and follow-ups

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `list_campaigns` | Lists comment campaigns and how many messages each has sent. | All roles | Reads |
| `create_campaign` | Creates a campaign: a comment with a keyword gets a private message. | Admin, Editor | Changes |
| `update_campaign` | Changes a comment campaign. | Admin, Editor | Changes |
| `delete_campaign` | Deletes a comment campaign. | Admin, Editor | Asks first |
| `set_followups` | Sets follow-ups for people who asked about prices and didn't book. | Admin, Editor | Changes |
| `list_broadcasts` | Lists sent broadcasts and how many people got each. | All roles | Reads |
| `preview_broadcast` | Shows how many people a broadcast would reach, sending nothing. | Admin, Editor | Reads |
| `send_broadcast` | Sends a broadcast to a group of past customers now. | Admin, Editor | Asks first |
| `cold_leads` | Lists people who showed interest and never booked or bought. | All roles | Reads |
| `sort_cold_leads` | Has the AI sort cold leads by interest and why they stopped. | Admin, Editor | Changes |
| `get_broadcast` | Shows one broadcast, who got it and how each send went. | All roles | Reads |

## Bookings

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `booking_setup` | Shows how bookings work for the assistant and the next free times. | All roles | Reads |
| `set_booking_hours` | Sets the built-in opening hours and time zone for bookings. | Admin, Editor | Changes |
| `list_bookings` | Lists upcoming or past bookings, with moves and cancellations. | All roles | Reads |
| `cancel_booking` | Cancels a booking and frees the time. | Admin, Editor, Agent, Client | Asks first |
| `calendar` | Shows bookings and blocked time in the business's time zone. | All roles | Reads |
| `block_time` | Blocks time from bookings: days off or part of a day. | Admin, Editor, Agent, Client | Changes |
| `unblock_time` | Removes blocked time from the calendar. | Admin, Editor, Agent, Client | Asks first |
| `reviews` | Shows how customers rated their visits and what unhappy ones said. | All roles | Reads |
| `set_reviews` | Sets up asking for a review after appointments. | Admin, Editor | Changes |
| `services_and_team` | Shows the service menu and the team with their hours. | All roles | Reads |
| `set_services` | Replaces the service menu and the team. | Admin, Editor | Asks first |
| `add_menu_questions` | Adds service and staff questions to every booking flow. | Admin, Editor | Changes |
| `booking_page` | Shows the online booking page, its link and last 30 days. | All roles | Reads |
| `set_booking_page` | Switches the online booking page on or off and sets it up. | Admin, Editor | Changes |
| `rebooking` | Shows next-visit offers: who is due, who was offered, who rebooked. | All roles | Reads |
| `set_no_show_protection` | Sets confirmations, released times and deposits against no-shows. | Admin, Editor | Changes |
| `mark_no_show` | Marks a past booking as missed, or undoes it. | Admin, Editor, Agent, Client | Changes |
| `calendar_links` | Gives the private calendar feed links for each team member. | Admin, Editor | Reads |
| `waiting_list` | Lists people waiting for a time to come free. | All roles | Reads |
| `remove_from_waiting_list` | Takes someone off the waiting list. | Admin, Editor, Agent, Client | Changes |
| `reset_calendar_links` | Makes new calendar links for everyone, and the old ones stop working. | Admin, Editor | Asks first |

## Shop, payments and loyalty

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `online_payments` | Shows the client's online payment connection and what uses it. | All roles | Reads |
| `set_payment_provider` | Switches which payment provider takes payments. | Admin, Editor | Asks first |
| `loyalty_card` | Shows the loyalty card settings and each customer's stamps. | All roles | Reads |
| `set_loyalty_card` | Switches the loyalty card on or off and sets its reward. | Admin, Editor | Changes |
| `use_loyalty_reward` | Marks a customer's loyalty reward as used. | Admin, Editor, Agent, Client | Changes |
| `packages` | Lists the packages of visits and gift cards the business sells. | All roles | Reads |
| `set_packages` | Replaces the list of packages and gift cards. | Admin, Editor | Changes |
| `list_vouchers` | Lists packages and gift cards people bought, with what's left. | All roles | Reads |
| `sell_voucher` | Records a package or gift card sold. | Admin, Editor, Agent, Client | Changes |
| `use_voucher` | Takes a visit off a package or an amount off a gift card. | Admin, Editor, Agent, Client | Changes |
| `mark_voucher_paid` | Activates a package or gift card paid outside online payment. | Admin, Editor, Agent, Client | Changes |
| `referrals` | Shows bring-a-friend: who invited friends and whose reward is due. | All roles | Reads |
| `set_referral` | Switches bring-a-friend on or off and sets the rewards. | Admin, Editor | Changes |
| `shop` | Shows the shop page, pickup, delivery and last 30 days. | All roles | Reads |
| `set_shop` | Switches the shop page on or off and sets pickup and delivery. | Admin, Editor | Changes |
| `list_products` | Lists the shop's products with price and stock. | All roles | Reads |
| `save_product` | Adds or changes a shop product. | Admin, Editor | Changes |
| `list_orders` | Lists shop orders, with counts by status and recent revenue. | All roles | Reads |
| `set_order_status` | Moves an order to its next status and tells the customer. | Admin, Editor, Agent, Client | Changes |
| `cancel_voucher` | Cancels a package or gift card so it can't be used. | Admin, Editor, Agent, Client | Asks first |
| `referral_code` | Gives a customer their bring-a-friend code and link. | Admin, Editor, Agent, Client | Changes |
| `mark_referral_rewarded` | Marks that the customer who invited a friend got their reward. | Admin, Editor, Agent, Client | Changes |
| `delete_product` | Deletes a product from the shop. | Admin, Editor | Asks first |
| `customer_loyalty_card` | Shows one customer's loyalty card: stamps and rewards. | All roles | Reads |

## Instagram, posts and reviews

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `schedule_post` | Schedules an Instagram post for a set time. | Admin, Editor | Changes |
| `list_posts` | Lists scheduled, published and failed posts. | All roles | Reads |
| `cancel_post` | Deletes a post that isn't published yet. | Admin, Editor | Asks first |
| `list_instagram_posts` | Lists the connected account's recent Instagram posts. | All roles | Reads |
| `draft_caption` | Writes an Instagram caption from a short brief, using the knowledge. | Admin, Editor | Changes |
| `post_stats` | Shows each post's and story's reach, likes, leads and bookings. | All roles | Reads |
| `make_content_plan` | Asks the AI for post ideas based on what worked on the account. | Admin, Editor | Changes |
| `content_plan` | Shows the latest content plan with its post ideas. | All roles | Reads |
| `plan_idea_to_scheduler` | Puts a content plan idea into the scheduler as a draft. | Admin, Editor | Changes |
| `set_post_approval` | Makes scheduled posts wait for the business owner's approval. | Admin, Editor | Changes |
| `posts_to_approve` | Lists posts waiting for the owner's approval. | All roles | Reads |
| `decide_post` | Approves a post or asks for changes, as the owner decided. | Admin, Editor, Client | Changes |
| `google_reviews` | Shows the business's Google reviews with AI reply drafts. | All roles | Reads |
| `reply_to_google_review` | Publishes a public reply to a Google review, or redrafts it. | Admin, Editor, Agent, Client | Asks first |
| `skip_google_review` | Leaves a Google review without a reply, or puts it back. | Admin, Editor, Agent, Client | Changes |
| `set_google_reviews` | Sets up Google reviews: the business location, auto replies and drafts. | Admin, Editor | Changes |
| `moderation` | Shows comment moderation settings and recently hidden or flagged comments. | All roles | Reads |
| `set_moderation` | Sets what comment moderation hides and flags. | Admin, Editor | Changes |
| `restore_comment` | Shows a hidden comment again. | Admin, Editor, Agent, Client | Changes |
| `edit_post` | Changes a post that isn't published yet. | Admin, Editor | Changes |
| `publish_post_now` | Publishes a scheduled post on Instagram right away. | Admin, Editor | Asks first |
| `moderate_comment` | Hides a comment after all, or marks a flagged one as answered. | Admin, Editor, Agent, Client | Changes |
| `try_moderation` | Shows what moderation would do with a comment, changing nothing. | Admin, Editor | Reads |
| `delete_google_review_reply` | Takes the business's public reply off a Google review. | Admin, Editor, Agent, Client | Asks first |

## Channels, website chat and domains

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `instagram_setup` | Shows the Instagram connection and the link to connect an account. | All roles | Reads |
| `website_chat` | Shows the website chat's settings, link, code and last 30 days. | All roles | Reads |
| `set_website_chat` | Switches the website chat on or off and sets it up. | Admin, Editor | Changes |
| `channels_status` | Shows the WhatsApp, Messenger and Telegram connections. | All roles | Reads |
| `list_domains` | Lists clients' own domains and their state. | Admin | Reads |
| `add_domain` | Gives a client their own address and returns the DNS records to add. | Admin | Changes |
| `check_domain` | Checks again whether a domain's DNS records and certificate are ready. | Admin | Changes |
| `move_domain` | Points a custom domain at another client. | Admin | Changes |
| `set_domain_firewall` | Lets a client's website chat answer only through their own firewall, or everywhere again. | Admin | Asks first |
| `new_domain_firewall_secret` | Makes a new secret for a domain whose chat answers only through the client's firewall. | Admin | Changes |
| `remove_domain` | Removes a client's own domain. | Admin | Asks first |
| `disconnect_instagram` | Disconnects the assistant's Instagram account. | Admin, Editor | Asks first |

## Privacy (GDPR)

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `find_person` | Finds a person for a data request by username or id. | Admin, Editor | Reads |
| `export_person_data` | Exports everything stored about one person. | Admin, Editor | Reads |
| `erase_person` | Erases everything stored about one person, for good. | Admin, Editor | Asks first |
| `privacy_audit_log` | Shows the privacy audit log: exports, erasures and data requests. | Admin, Editor | Reads |

## Results and reports

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `bot_insights` | Shows how the assistant is doing: people, answers, hand-offs, leads, AI cost. | All roles | Reads |
| `send_monthly_report` | Emails the client their monthly report. | Admin, Editor | Asks first |
| `weekly_report` | Shows the weekly owner report: leads, reply times, lost chats, team workload. | All roles | Reads |
| `team_performance` | Shows how fast each team member answers and what it brings. | All roles | Reads |
| `earnings` | Shows the value of bookings, sales and team time that went through the assistant. | All roles | Reads |
| `set_earnings_settings` | Sets how the earnings page counts the team's time. | Admin, Editor | Changes |
| `ad_report` | Shows which click-to-message ads brought chats, leads and buyers. | All roles | Reads |
| `client_health` | Shows which clients are drifting away, most at risk first. | All roles | Reads |
| `team_analytics` | Shows how the team uses the platform: active people, pages, actions. | Admin | Reads |
| `platform_analytics` | Shows totals across the agency's assistants against the period before. | Admin | Reads |

## Your agency: team, branding and billing

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `billing_overview` | Shows what each client owes for a month and whether it's paid. | Admin | Reads |
| `client_statement` | Shows a client's statement month by month, as the owner sees it. | Admin, Client | Reads |
| `set_client_fee` | Sets a client's monthly fee, AI billing and payment link. | Admin | Asks first |
| `client_plans` | Lists the plans the agency offers its clients. | Admin | Reads |
| `save_client_plan` | Creates or changes a client plan. | Admin | Asks first |
| `client_payment_link` | Gives a link for the business owner to pay their plan online. | Admin | Reads |
| `set_client_plan` | Puts a client on a plan, or takes it off. | Admin | Asks first |
| `mark_month_paid` | Records a client's payment for a month. | Admin | Asks first |
| `payment_settings` | Shows or sets payment reminders and receipts for clients. | Admin | Changes |
| `demos` | Lists demo assistants made for prospects and how they were used. | Admin, Editor | Reads |
| `make_demo` | Builds a 7-day demo assistant for a prospect from their website. | Admin, Editor | Changes |
| `demo_action` | Extends, keeps or deletes a demo assistant. | Admin, Editor | Changes |
| `change_my_plan` | Moves your agency to another platform plan. | Admin | Asks first |
| `my_plan` | Shows your agency's plan, its status and a link to pay. | Admin | Changes |
| `cancel_my_plan` | Stops paying for your agency's plan through WayForPay. | Admin | Asks first |
| `delete_client_plan` | Deletes one of the agency's client plans. | Admin | Asks first |
| `unmark_month_paid` | Undoes a client payment recorded by mistake. | Admin | Asks first |
| `list_users` | Lists the agency's team with their roles and access. | Admin | Reads |
| `add_user` | Invites someone to the team by email. | Admin | Asks first |
| `update_user` | Changes a team member's role, access or account status. | Admin | Asks first |
| `remove_user` | Deletes a team member's account, keeping their work. | Admin | Asks first |
| `resend_invite` | Sends a team invitation email again. | Admin | Changes |
| `sign_out_user` | Signs a team member out everywhere. | Admin | Changes |
| `reset_private_links` | Makes new intake and calendar links for the agency or one client; the old ones stop working. | Admin | Asks first |
| `branding` | Shows the agency's branding: name, logo, colour and contacts. | All roles | Reads |
| `set_branding` | Changes the agency's branding. | Admin | Changes |
| `legal_details` | Shows the agency's details on its privacy and terms pages. | All roles | Reads |
| `set_legal_details` | Changes the agency's details on its legal pages. | Admin | Changes |
| `send_test_email` | Sends you a test email to check that email sending works. | Admin | Changes |
| `my_alerts` | Shows which alerts you get and where. | All roles | Reads |
| `set_my_alerts` | Turns your alerts on or off. | All roles | Changes |
| `test_my_alerts` | Sends a test alert to your devices and Telegram. | All roles | Changes |

## The platform (owner only)

| Tool | What it does | Who can use it | Kind |
| - | - | - | - |
| `system_status` | Shows the running version, the database's change history, backups and the last restore drill, uptime checks, and whether Jev picks flow topics with this month's Jev calls and cost. | Platform owner | Reads |
| `server_errors` | Lists server errors, grouped by what failed and where. | Platform owner | Reads |
| `mark_error_fixed` | Marks a server error, or every open one, as fixed. | Platform owner | Changes |
| `run_backup_now` | Starts a backup now. | Platform owner | Changes |
| `bot_check` | Shows the bot check on public forms. | Platform owner | Reads |
| `set_bot_check` | Changes the bot check on public forms. | Platform owner | Changes |
| `list_agencies` | Lists every agency on the platform with its assistants and status. | Platform owner | Reads |
| `create_agency` | Adds an agency and invites its first admin. | Platform owner | Changes |
| `plans` | Lists the plans agencies pay the platform. | Platform owner | Reads |
| `save_plan` | Creates or changes a platform plan. | Platform owner | Asks first |
| `included_ai` | Shows the platform's included AI and each agency's use this month. | Platform owner | Reads |
| `delete_plan` | Deletes a platform plan no agency is on. | Platform owner | Asks first |
| `signup_settings` | Shows self sign-up of new agencies: on or off, plan and trial. | Platform owner | Reads |
| `set_signup` | Changes self sign-up of new agencies. | Platform owner | Asks first |
| `set_unpaid_rules` | Sets grace days and auto-pause for agencies that don't pay. | Platform owner | Asks first |
| `update_agency` | Changes an agency: name, limit, features, notes or plan. | Platform owner | Asks first |
| `pause_agency` | Pauses an agency: its team is signed out and its assistants stop. | Platform owner | Asks first |
| `resume_agency` | Resumes a paused agency. | Platform owner | Changes |
| `delete_agency` | Deletes an agency that signed itself up, with all its data. | Platform owner | Asks first |
| `switch_agency` | Works inside another agency as its admin would. | Platform owner | Changes |
| `get_agency` | Shows one agency in full, with its admins. | Platform owner | Reads |


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