> For the complete documentation index, see [llms.txt](https://docs.mylinkconnect.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mylinkconnect.com/available-tools.md).

# Available Tools

The MyLINKConnect MCP exposes a set of tools that let your LLM client read information from and, where allowed, make changes to your MyLINKConnect account and its bots.

**Read vs. Write**

* Read tools only retrieve information and never change anything.
* Write tools (marked 🔒) modify your account or bots and require the mcp:bots.write permission.
* Some channel changes are staged in the bot's draft and only take effect after you publish the bot (marked ⏳ see publish\_bot).

**Resolving a bot**

Most tools accept a bot either by name or by id. If you're unsure, ask the LLM to list your bots first (list\_bots) so it can resolve the name to an id.

### Account

Information about your account as a whole: plan, usage, and settings.

| Tool                         | Description                                                                                                                                                                                                                        |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_account_overview`       | Account overview: whether API/MCP access is enabled, number of bots, whether the message quota has been exceeded, and current plan usage/limits.                                                                                   |
| `get_account_capabilities`   | Plan capabilities: feature flags (AI/LLM, webhooks, campaigns, SSO, DLR stats…), plan limits (max bots, monthly messages, storage, AI tokens…), enabled channels, and live checks (can the account create a bot, use AI/NLP/LLM…). |
| `get_account_settings`       | Locale/config settings: UI language, timezone, white-label domain, and available languages.                                                                                                                                        |
| `get_account_storage`        | Storage usage: bytes used, quota, used percentage, and subscription state.                                                                                                                                                         |
| `get_account_message_totals` | Total messages across **all** bots for a period, split into sent and received.                                                                                                                                                     |
| `get_channel_usage`          | Most-used channels across all bots for a period, ranked by message volume.                                                                                                                                                         |
| `count_bots`                 | Number of bots in the account.                                                                                                                                                                                                     |

### Bots

Listing, ranking, and inspecting how a bot is built.

| Tool                   | Description                                                                                                |
| ---------------------- | ---------------------------------------------------------------------------------------------------------- |
| `list_bots`            | Lists all bots with id, name, and enabled channels. **Use this first** to resolve a bot name to an id.     |
| `rank_bots_by_traffic` | Ranks bots by total lifetime message traffic, busiest first.                                               |
| `get_bot_structure`    | Structural digest of a bot: type, locale, channels, behaviours, chat variables, and webhook configuration. |
| `get_bot_behaviour`    | Flow map of a single behaviour: its interactions, the actions inside them, and how they connect.           |
| `get_bot_interaction`  | Full detail of a single interaction, including the complete parameter payload of every action.             |
| `publish_bot` 🔒       | Publishes the bot, making **all** pending draft changes live at once.                                      |

### Channels

Reading and changing a bot's messaging channels (WhatsApp, Telegram, Facebook, Web…).

| Tool                            | Description                                                                                                                                 |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_bot_channel_settings` 🔒   | Current configuration of a channel. May include credentials/secrets, so it requires write permission.                                       |
| `set_bot_channel_settings` 🔒 ⏳ | Updates a channel's configuration (merges by default; `replace=true` overwrites the whole blob). Staged in the draft: **publish to apply**. |
| `set_bot_channel` 🔒 ⏳          | Enables or disables a channel. Staged in the draft: **publish to apply**.                                                                   |

### AI & NLP

The bot's AI/LLM module, knowledge base, and natural-language assets.

| Tool                    | Description                                                                                                                                                                                         |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_bot_ai_module`     | AI/LLM configuration: provider and model, system instructions, RAG retrieval settings, caching, training state, and a summary of attached resources/functions. Service API keys are never returned. |
| `list_bot_ai_resources` | Knowledge-base (RAG) resources: file name, source, size, indexing status, and vector chunk/token counts.                                                                                            |
| `list_bot_ai_functions` | Functions (tool calls) declared on the AI module: name, instructions, parameter schema, and the behaviour each one triggers.                                                                        |
| `get_bot_nlp`           | The bot's NLP assets: count and names of intents and entities.                                                                                                                                      |

### Analytics

Usage and engagement metrics for a single bot over a time period.

| Tool                        | Description                                                       |
| --------------------------- | ----------------------------------------------------------------- |
| `get_bot_message_count`     | Messages sent/received by a bot over a period.                    |
| `get_bot_channel_breakdown` | A bot's message volume broken down by channel.                    |
| `get_bot_engagement`        | New, returning, and active users over a period.                   |
| `get_bot_delivery_receipts` | Delivery-receipt (DLR) statistics, grouped by channel and status. |

> **Time periods**: analytics tools accept a `period` preset: `today`, `yesterday`, `last_7_days`, `last_14_days`, `last_30_days`, `this_week`, `last_week`, `this_month`, `last_month` (default), `this_year`, `lifetime`.

### Broadcasts & Campaigns

Scheduled and triggered messaging.

| Tool                     | Description                                                                                                            |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `get_bot_broadcasts`     | Lists all of a bot's broadcasts (including drafts and disabled), with scheduling mode and delivery counters.           |
| `get_bot_broadcast`      | Full detail of a single online broadcast: scheduling, targeting, counters, and the behaviour holding its message flow. |
| `get_bot_broadcast_logs` | A single day's broadcast delivery log entries (paginated). May include end-user personal information.                  |
| `list_bot_campaigns`     | Lists broadcast campaigns and the broadcasts belonging to each.                                                        |
| `list_bot_audiences`     | Lists reusable targeting segments (audiences) and the filter rules that define them.                                   |
| `list_bot_goals`         | Lists analytics goals: name, target value, and measure unit.                                                           |
| `list_bot_calendars`     | Lists availability calendars (operator presence / office hours).                                                       |

### Database

The bot's data collections.

| Tool                         | Description                                                                                                    |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `list_bot_collections`       | Lists database collections with their field schema, record counts, and read/write counters.                    |
| `get_bot_collection_records` | Returns the stored records of a collection (paginated, filterable). May include end-user personal information. |

### Team & Permissions

Team members, operator roles, and account admins.

| Tool                                  | Description                                                                                   |
| ------------------------------------- | --------------------------------------------------------------------------------------------- |
| `list_team_members`                   | Lists the account's team members (email, name, role, invite state, presence).                 |
| `get_bot_team`                        | Lists a specific bot's team members plus member/pending/online counts.                        |
| `get_online_operators`                | Team members/operators currently online across the account.                                   |
| `list_bot_profiles`                   | Lists the operator profiles (permission roles) defined on a bot.                              |
| `get_bot_profile`                     | Full permission set of a single operator profile.                                             |
| `create_bot_profile` 🔒               | Creates a new operator profile with the given permission flags.                               |
| `set_bot_profile_permissions` 🔒      | Updates a profile's permissions propagates immediately to every member assigned that profile. |
| `delete_bot_profile` 🔒               | Deletes an operator profile (fails if still assigned to any member).                          |
| `set_team_member_profile` 🔒          | Assigns an operator profile to a team member (applies immediately).                           |
| `list_additional_admins`              | Lists account-level admins (co-owners) and their full permission set.                         |
| `set_additional_admin_permissions` 🔒 | Updates an existing additional admin's account-level permissions.                             |
| `list_bot_templates`                  | Lists operator canned-reply templates used during human take-over.                            |