# FavCRM (remote · api.favcrm.io)

Agentic CRM for service businesses — bookings, customers, WhatsApp, loyalty, invoicing.

- Trust score: 82/100 (high trust)
- Change this week: +8
- Registry status: active
- Liveness: live
- Owner verified: no
- Last scored: 2026-08-03

## Components

- remote · `api.favcrm.io`: 82/100 (this document), [markdown](https://verifymcp.io/servers/io-favcrm-favcrm/api.md), [page](https://verifymcp.io/servers/io-favcrm-favcrm/api)

## Channel facts

- Endpoint: `https://api.favcrm.io/mcp`
- Transports: `streamable-http`
- Auth: `none`
- Version: `1.0.0`

## Trust breakdown

How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. Scores are 0–100 per category. Scoring method: https://verifymcp.io/docs/scoring (what has changed: https://verifymcp.io/docs/scoring/changelog)

Scored 2026-08-03.

- **Endpoint Security**: 89/100
  - The endpoint's TLS certificate is valid, in date, and uses a strong key.
  - Authorisation is enforced on tool calls, but the challenge carries no valid RFC 9728 metadata, so a client cannot discover where to get a token.
  - HTTPS is enforced; there's no plaintext access path.
  - The HSTS (Strict-Transport-Security) header is present.
  - DNSSEC check failed: this domain isn't protected by DNSSEC.
- **Transport & Reachability**: 100/100
  - Verified streamable-http transport via a live MCP handshake.
- **Schema Quality & AI Usability**: 85/100
  - 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).
  - AI-judged instruction clarity (excellent).
  - Tool/resource definitions use about 18916 tokens (~82/item across 228 items; 223 tools + 5 resources), lean.
  - Usage-examples check failed: none of the tools include examples.
- **Stability & Change Management**: 27/100
  - Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.
- **Tool Coverage**: 100/100
  - 100% of tools have a non-trivial description (not blank, and not just the tool's name).
  - 100% of tool parameters carry a description.
  - Structured output schemas are declared (100% of tools); any adoption earns full credit.
- **Capabilities**: 100/100
  - Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.

## Install

### Claude

```bash
claude mcp add --transport http io-favcrm-favcrm https://api.favcrm.io/mcp
```

### Codex

```toml
[mcp_servers.io-favcrm-favcrm]
url = "https://api.favcrm.io/mcp"
```

### opencode

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "io-favcrm-favcrm": {
      "type": "remote",
      "url": "https://api.favcrm.io/mcp",
      "enabled": true
    }
  }
}
```

### OpenClaw

```bash
openclaw mcp add io-favcrm-favcrm --url https://api.favcrm.io/mcp --transport streamable-http
```

### Hermes

```yaml
mcp_servers:
  io-favcrm-favcrm:
    url: "https://api.favcrm.io/mcp"
```

### Other

```json
{
  "mcpServers": {
    "io-favcrm-favcrm": {
      "type": "http",
      "url": "https://api.favcrm.io/mcp"
    }
  }
}
```

The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.

## Changelog

Every change recorded for this component, newest first. Days that predate change tracking, or that we cannot explain, say so: "we were watching and nothing happened" and "we were not watching" are different claims.

### 2026-08-03 (score 82, +1)

No change was recorded against any check on this day. Stability & Change Management went from 23 to 27. That category is still filling its 30-day observation window: 7 days of observed history at the previous scan, 8 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-08-01 (score 81, +1)

No change was recorded against any check on this day. Stability & Change Management went from 17 to 20. That category is still filling its 30-day observation window: 5 days of observed history at the previous scan, 6 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-07-31 (score 80, +4)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-30 (score 76, 0)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-29 (score 76, +1)

No change was recorded against any check on this day. Stability & Change Management went from 7 to 10. That category is still filling its 30-day observation window: 2 days of observed history at the previous scan, 3 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-07-28 (score 75, +1)

No change was recorded against any check on this day. Stability & Change Management went from 3 to 7. That category is still filling its 30-day observation window: 1 days of observed history at the previous scan, 2 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-07-27 (score 74, 0)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-26 (score 74)

First indexed and scored.

## MCP tools (223)

### `search_members` (~320 tokens)

Search and filter members/accounts. Supports text search, date ranges, booking/activity history, membership tier, tags, and more. Use lastBookingBefore/inactiveDays to find inactive members.

Input parameters:

- `createdAfter` (string): ISO date — accounts created after this date
- `createdBefore` (string): ISO date — accounts created before this date
- `hasBooking` (boolean): Filter to members with/without any booking
- `hasMembership` (boolean): Filter to members with active membership
- `inactiveDays` (number): Members with no activity in the last N days
- `lastActivityAfter` (string): ISO date — members with activity after this date
- `lastActivityBefore` (string): ISO date — members with no activity since this date
- `lastBookingAfter` (string): ISO date — members who have a booking after this date
- `lastBookingBefore` (string): ISO date — members whose last booking is before this date (or have no bookings)
- `lifeStage` (string): Filter by life stage
- `limit` (number): Max results (default 20)
- `membershipStatus` (string): Filter by membership status
- `order` (string): Sort order
- `search` (string): Name, email, or phone to search
- `sort` (string): Sort column: name, email, or createdAt
- `source` (string): Filter by account source
- `tagIds` (array): Filter by tag IDs
- `tierId` (string): Filter by membership tier ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_member_profile` (~31 tokens)

Get detailed profile for a specific member/account by ID.

Input parameters:

- `accountId` (string, required): The account ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `preview_customer_import` (~72 tokens)

Preview a bulk customer import (max 2000 rows). Matches existing accounts by phone/email and shows create vs update actions plus points/stamps/credit deltas. Use commit_customer_import with the returned sessionId to apply.

Input parameters:

- `filename` (string): Original filename for audit
- `rows` (array, required)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `commit_customer_import` (~65 tokens)

Commit a previewed customer import. Pass the same rows and sessionId returned by preview_customer_import. Creates/updates accounts and applies points, stamps, and credit deltas.

Input parameters:

- `rows` (array, required)
- `sessionId` (string, required): sessionId from preview_customer_import

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_account` (~205 tokens)

Create a CRM account/customer with a primary contact. Optionally enroll the account as a member; use enrol_membership later when the account already exists.

Input parameters:

- `address` (object): Postal address
- `email` (string): Email address
- `enrollMembership` (boolean): Whether to create an active membership immediately
- `expiresAt` (string): Optional ISO expiry for the membership
- `firstName` (string): First name for individual accounts
- `lastName` (string): Last name for individual accounts
- `lifeStage` (string): CRM life stage. Defaults to active.
- `name` (string, required): Account/customer display name
- `notes` (string): Internal notes
- `phone` (string): Phone number
- `source` (string): Acquisition source. Defaults to api.
- `tierId` (string): Membership tier ID to enroll into. If omitted, the company default tier may apply.
- `type` (string): Account type. Defaults to individual.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_account` (~208 tokens)

Update CRM account/customer profile fields such as name, phone, email, life stage, owner, notes, or member code.

Input parameters:

- `accountId` (string, required): The account ID to update
- `assignedTo`: Assigned team member user ID, or null to clear
- `dateOfBirth`: YYYY-MM-DD date of birth, or null to clear
- `email` (string): Email address
- `firstName`: First name for individual accounts
- `gender` (string): Gender
- `lastName`: Last name for individual accounts
- `lifeStage` (string): CRM life stage
- `memberCode`: Merchant member code, or null to clear
- `name` (string): Account/customer display name
- `notes` (string): Internal notes
- `phone` (string): Phone number
- `referredByAccountId`: Referrer account ID, or null to clear
- `source` (string): Acquisition source
- `type` (string): Account type

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_account` (~44 tokens)

Soft-delete a CRM account/customer. This releases the primary phone for future reuse while keeping account history for audit.

Input parameters:

- `accountId` (string, required): The account ID to soft-delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_tags` (~27 tokens)

List all available tags for the merchant.

Input parameters:

- `search` (string): Search tags by name

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_tag` (~45 tokens)

Create a CRM tag for customer segmentation and organization.

Input parameters:

- `color` (string): Optional display color, e.g. #2563eb
- `name` (string, required): Tag name

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_tag` (~52 tokens)

Rename or recolor an existing CRM tag.

Input parameters:

- `color`: New color, or null to clear
- `name` (string): New tag name
- `tagId` (string, required): The tag ID to update

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_tag` (~33 tokens)

Delete a CRM tag and remove it from all tagged entities.

Input parameters:

- `tagId` (string, required): The tag ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `attach_tags` (~55 tokens)

Attach one or more tags to a member/account. Useful for segmenting members after filtering.

Input parameters:

- `accountIds` (array, required): Member/account IDs to tag (max 100)
- `tagId` (string, required): Tag ID to attach

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `detach_tags` (~50 tokens)

Detach one tag from one or more member/account records.

Input parameters:

- `accountIds` (array, required): Member/account IDs to untag (max 100)
- `tagId` (string, required): Tag ID to detach

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_tiers` (~19 tokens)

List all membership tiers with member counts and stats.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_membership_tier` (~30 tokens)

Get a specific membership tier by ID.

Input parameters:

- `tierId` (string, required): The tier ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `issue_rewards` (~78 tokens)

Issue a gift/reward to multiple members. Requires a gift offer ID and member IDs.

Input parameters:

- `expiresAt` (string): Optional ISO date when the reward expires
- `giftOfferId` (string, required): The gift offer/reward scheme ID to issue
- `memberIds` (array, required): Member/account IDs to receive the reward (max 50)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `enrol_membership` (~101 tokens)

Enrol a member into a membership tier. Free tiers enrol immediately; paid tiers return PAYMENT_REQUIRED unless skipPriceCheck is set. Use list_tiers first to find the target tier.

Input parameters:

- `accountId` (string, required): The member/account ID to enrol
- `expiresAt` (string): Optional ISO date to override the tier-computed expiry.
- `tierId` (string): The membership tier ID. Omit to enrol on the default no-tier membership.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_loyalty_balance` (~54 tokens)

Get a member's current loyalty balance — points, stamps, credits, lifetime totals, and active membership tier. Returns null if the member is not enrolled.

Input parameters:

- `accountId` (string, required): The member/account ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `earn_loyalty_points` (~104 tokens)

Credit loyalty points or stamps to a member. Use field="points" for points, "stamps" for stamps. Server records a transaction with the reason as audit context.

Input parameters:

- `accountId` (string, required): The member/account ID
- `amount` (integer, required): Positive integer amount to credit
- `field` (string, required): Which loyalty unit to credit
- `reason` (string): Audit-trail reason (e.g. "Booking completed", "Manual adjustment")

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_dashboard_stats` (~40 tokens)

Get high-level business KPIs: member count, new members this week, active subscriptions, total points issued, active promotions, rewards redeemed, messages sent.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_bookings` (~119 tokens)

List bookings with filters for date range, status, service, staff, or member.

Input parameters:

- `accountId` (string): Filter by member/account ID
- `dateFrom` (string): ISO date — bookings from this date
- `dateTo` (string): ISO date — bookings up to this date
- `limit` (number): Max results (default 20)
- `serviceId` (string): Filter by service ID
- `staffId` (string): Filter by staff member ID
- `status` (string): Filter by booking status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_booking_detail` (~34 tokens)

Get full booking details including line items, status history, and participants.

Input parameters:

- `bookingId` (string, required): The booking ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_booking_stats` (~26 tokens)

Get booking counts: today, this week, this month, and breakdown by status.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_available_slots` (~79 tokens)

Find available booking slots for a service on a specific date.

Input parameters:

- `date` (string, required): ISO date to check (YYYY-MM-DD)
- `resourceId` (string): Optional: filter by specific resource
- `serviceId` (string, required): The service to check availability for
- `staffId` (string): Optional: filter by specific staff member

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_services` (~54 tokens)

List booking services with name, price, duration, and status.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by name
- `status` (string): Filter by status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_service_detail` (~35 tokens)

Get full service details including addons, staff, resources, and tier pricing.

Input parameters:

- `serviceId` (string, required): The service ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_service` (~319 tokens)

Create a bookable service. Sets duration, price, capacity, and policies. Use list_service_categories first if you want to attach to an existing category.

Input parameters:

- `allowedTierIds` (array): Required when visibility=members_only
- `capacity` (number): How many participants per slot (default 1)
- `categoryId` (string): Existing service category ID
- `commissionCurrency`: Commission currency (ISO code)
- `commissionType`: Commission type: "fixed" or "percentage"
- `commissionValue`: Commission amount as decimal string
- `cooldownMinutes` (number): Minimum gap before bookings can be cancelled (default 0)
- `currency` (string): ISO currency code, default HKD
- `description` (string): Description
- `durationMinutes` (number, required): Duration of one booking in minutes
- `name` (string, required): Service name
- `price` (string): Decimal string, e.g. "80.00". Defaults to "0".
- `requireLogin` (boolean): Default true — guests cannot book
- `requiresConfirmation` (boolean): If true, bookings start as pending and need confirm_booking
- `requiresResource` (boolean): Whether the service requires a resource (room/equipment)
- `requiresStaff` (boolean): Whether the service requires staff assignment
- `sortOrder` (number): Sort order (lower = earlier)
- `status` (string): Default active
- `type` (string): Default one_on_one
- `visibility` (string): Visibility: public | members_only | hidden

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_service` (~241 tokens)

Update an existing booking service. Pass only the fields you want to change.

Input parameters:

- `capacity` (number): Participants per slot
- `categoryId`: Category ID
- `commissionCurrency`: Commission currency (ISO code)
- `commissionType`: Commission type: "fixed" or "percentage"
- `commissionValue`: Commission amount as decimal string
- `cooldownMinutes` (number): Cooldown minutes between bookings
- `description` (string): Description
- `durationMinutes` (number): Duration of one booking in minutes
- `name` (string): Name
- `price` (string): Decimal string, e.g. "80.00"
- `requireLogin` (boolean): If true, guests cannot book without an account
- `requiresConfirmation` (boolean): If true, bookings start pending and need explicit confirmation
- `requiresResource` (boolean): Whether the service requires a resource (room/equipment)
- `requiresStaff` (boolean): Whether the service requires staff assignment
- `serviceId` (string, required): Service ID to update
- `status` (string): Status filter
- `visibility` (string): Visibility: public | members_only | hidden

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_service_schedule` (~203 tokens)

Create a bookable schedule window for a service, including recurring weekly/daily availability.

Input parameters:

- `byWeekday` (array): Weekdays for weekly recurrence: 0=Mon, 1=Tue, ... 6=Sun
- `date` (string, required): Start date or one-off date (YYYY-MM-DD)
- `endTime` (string, required): HH:MM (24h)
- `maxCapacity` (number): Max bookings per generated slot
- `notes` (string): Free-form notes
- `recurrence` (string): Default none
- `recurrenceEndDate` (string): YYYY-MM-DD
- `recurrenceInterval` (number): Default 1
- `resourceId` (string): Optional resource ID to bind this schedule to a room/resource
- `serviceId` (string, required): Service ID
- `staffId` (string): Optional companyMembers.id to bind this schedule to staff
- `startTime` (string, required): HH:MM (24h)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_service_schedules` (~100 tokens)

List schedule windows for booking services.

Input parameters:

- `dateFrom` (string): YYYY-MM-DD
- `dateTo` (string): YYYY-MM-DD
- `isOverride` (boolean): Filter to override entries only
- `limit` (number): Max results (default 20)
- `resourceId` (string): Resource ID (room/equipment)
- `serviceId` (string): Service ID
- `staffId` (string): Staff member ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_service_schedule` (~183 tokens)

Update a service schedule window. Pass only fields to change.

Input parameters:

- `byWeekday`: Weekdays (0=Mon..6=Sun) for weekly recurrence
- `date` (string): Date (YYYY-MM-DD)
- `endTime` (string): End time (HH:mm)
- `maxCapacity` (number): Maximum capacity for this slot
- `notes`: Free-form notes
- `recurrence` (string): Recurrence rule: none | daily | weekly | monthly
- `recurrenceEndDate`: Recurrence end date (YYYY-MM-DD)
- `recurrenceInterval` (number): Recurrence interval (e.g. every N weeks)
- `resourceId`: Resource ID (room/equipment)
- `scheduleId` (string, required): Schedule ID
- `staffId`: Staff member ID
- `startTime` (string): Start time (HH:mm)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `assign_staff_to_service` (~53 tokens)

Assign a staff member to a booking service. Pass users.id from list_staff.userId.

Input parameters:

- `serviceId` (string, required): Service ID
- `userId` (string, required): users.id from list_staff.userId

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `link_resource_to_service` (~39 tokens)

Link a room/resource to a booking service.

Input parameters:

- `resourceId` (string, required): Resource ID
- `serviceId` (string, required): Service ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_service_categories` (~25 tokens)

List service categories (groups for booking services like "Treatments", "Classes").

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_service_category` (~61 tokens)

Create a service category (e.g. "Treatments", "Classes") to group bookable services.

Input parameters:

- `description` (string): Description
- `name` (string, required): Category name
- `sortOrder` (number): Sort order (lower = earlier)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_resource` (~98 tokens)

Create a bookable resource (room, equipment, vehicle). Used by services that have requiresResource=true.

Input parameters:

- `capacity` (number): How many concurrent bookings (default 1)
- `description` (string): Description
- `name` (string, required): Resource name (e.g. "Treatment Room A")
- `status` (string): Default active
- `type` (string, required): Free-form type label, e.g. "room", "equipment"

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `set_resource_availability` (~134 tokens)

Add an availability window for a resource. Use day-of-week + recurring=true for weekly schedules, or a specific date for one-off blocks.

Input parameters:

- `date` (string): YYYY-MM-DD for a specific date instead of dayOfWeek
- `dayOfWeek` (string): Day of week (0=Sun..6=Sat)
- `endTime` (string, required): HH:MM (24h)
- `isRecurring` (boolean): Default true
- `resourceId` (string, required): Resource ID
- `startTime` (string, required): HH:MM (24h)
- `type` (string): Default available

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `set_staff_availability` (~142 tokens)

Add an availability window for a staff member (companyMembers.id). Use day-of-week + recurring for weekly schedules, or a specific date for one-off changes.

Input parameters:

- `date` (string): YYYY-MM-DD for a specific date instead of dayOfWeek
- `dayOfWeek` (string): Day of week (0=Sun..6=Sat)
- `endTime` (string, required): HH:MM (24h)
- `isRecurring` (boolean): Default true
- `memberId` (string, required): companyMembers.id of the staff
- `startTime` (string, required): HH:MM (24h)
- `type` (string): Default available

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_booking_settings` (~29 tokens)

Get global booking settings for the customer booking flow, cancellation rules, visibility options, and confirmation requirements.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_booking_settings` (~298 tokens)

Update global booking settings. Pass only the fields you want to change.

Input parameters:

- `allowMemberCancellation` (boolean): Allow members to cancel bookings from the customer portal
- `blockUntilFinished` (boolean): Block customers from booking again while they have active bookings
- `bookingReminderEnabled` (boolean): Send the default pre-booking reminder
- `bookingReminderLeadHours` (integer): Hours before booking start for the default reminder
- `calendarStyle` (string): Booking flow calendar presentation
- `cooldownMessage`: Optional message shown when cooldown blocks a booking
- `globalCooldownDays`: Minimum days between customer bookings, or null to disable
- `hideUnavailableTimeslots` (boolean): Hide unavailable timeslots instead of showing them as full
- `memberCancellationCutoffHours`: Hours before booking start when member cancellation closes, or null for no cutoff
- `minimumAdvanceBookingMinutes`: Minutes before slot start when customer booking closes. null/0 = no cutoff; set > 0 to require advance notice
- `requireBookingConfirmation` (boolean): Require merchant confirmation before bookings are confirmed
- `sameDayReminderEnabled` (boolean): Send an additional same-day reminder before booking start
- `sameDayReminderLeadHours` (integer): Hours before booking start for the same-day reminder
- `showAccessPass` (boolean): Show access pass/package options in booking flow
- `showCoupon` (boolean): Show coupon field in booking flow

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_tickets` (~82 tokens)

List support tickets with optional filters.

Input parameters:

- `accountId` (string): Filter by CRM account ID
- `category` (string): Filter by category
- `limit` (number): Max results (default 20)
- `priority` (string): Filter by priority
- `search` (string): Search by subject
- `status` (string): Filter by status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_ticket_stats` (~16 tokens)

Get ticket counts grouped by status.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_ticket` (~125 tokens)

Create a support ticket for a member issue.

Input parameters:

- `accountId` (string): Member/account ID this ticket is about
- `category` (string): Ticket category
- `contactEmail` (string): Contact email if no account ID
- `contactName` (string): Contact name if no account ID
- `contactPhone` (string): Contact phone if no account ID
- `description` (string): Detailed description of the issue
- `priority` (string): Ticket priority
- `source` (string): Where the ticket originated
- `subject` (string, required): Ticket subject/title

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_ticket_status` (~40 tokens)

Update the status of an existing support ticket.

Input parameters:

- `status` (string, required): New status
- `ticketId` (string, required): The ticket ID to update

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_surveys` (~53 tokens)

List surveys with optional status/search filters.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search survey title or description
- `status` (string): Filter by survey status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_survey` (~158 tokens)

Create a survey with custom question blocks. Publish it later or set status to published for immediate portal access.

Input parameters:

- `closeAt` (string): Optional ISO datetime when the survey closes
- `description` (string): Optional survey description
- `openAt` (string): Optional ISO datetime when the survey opens
- `questionBlocks` (array, required): Ordered survey question blocks
- `settings` (object): Survey settings such as allowMultipleResponses, collectEmail, collectIpAddress, requireAuthentication, showProgress, successMessage
- `slug` (string): Optional URL slug; generated from title when omitted
- `status` (string): Initial status
- `title` (string, required): Survey title
- `visibility` (string): Who can access the survey

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_survey` (~37 tokens)

Get survey detail, including blocks, publishing status, visibility, settings, and response count.

Input parameters:

- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_survey` (~150 tokens)

Update a survey draft or publishing configuration. Use questionBlocks to replace the ordered form block list.

Input parameters:

- `closeAt`: Optional ISO datetime when the survey closes
- `description`: Survey description
- `openAt`: Optional ISO datetime when the survey opens
- `questionBlocks` (array): Ordered survey question blocks
- `settings` (object): Survey settings such as allowMultipleResponses, collectEmail, collectIpAddress, requireAuthentication, showProgress, successMessage
- `slug` (string): URL slug
- `status` (string): Survey status
- `surveyId` (string, required): Survey ID
- `title` (string): Survey title
- `visibility` (string): Survey access mode

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `archive_survey` (~32 tokens)

Archive a survey and remove it from active survey lists.

Input parameters:

- `surveyId` (string, required): Survey ID to archive

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_survey_stats` (~31 tokens)

Get response and invitation metrics for a survey overview dashboard.

Input parameters:

- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_survey_responses` (~40 tokens)

List responses for a survey.

Input parameters:

- `limit` (number): Max responses (default 50)
- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_survey_invitations` (~48 tokens)

List survey invitation history without exposing token hashes or old invitation tokens.

Input parameters:

- `limit` (number): Max invitations (default 50)
- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_survey_invitation` (~143 tokens)

Create a token-auth survey invitation for a specific member/account or contact.

Input parameters:

- `accountId` (string): CRM account ID to invite
- `channel` (string): Intended channel, e.g. email, sms, whatsapp, link
- `contactId` (string): Contact ID to invite
- `expiresAt` (string): Optional invitation expiry ISO datetime
- `metadata` (object): Optional invitation metadata
- `recipientEmail` (string): Recipient email for link tracking
- `recipientName` (string): Recipient display name for link tracking
- `recipientPhone` (string): Recipient phone for link tracking
- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_survey_workflows` (~29 tokens)

List automation workflows attached to a survey.

Input parameters:

- `surveyId` (string, required): Survey ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `upsert_survey_workflow` (~93 tokens)

Create or update a survey automation workflow, usually triggered by survey_response_submitted.

Input parameters:

- `graph` (object, required): Workflow graph definition
- `name` (string, required): Workflow name
- `status` (string): Workflow status
- `surveyId` (string, required): Survey ID
- `trigger` (string): Trigger name, default from graph.trigger
- `workflowId` (string): Existing workflow ID when updating

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_deals` (~92 tokens)

List CRM deals (sales pipeline) with optional filters.

Input parameters:

- `accountId` (string): Filter by account
- `dealType` (string): Filter by deal type
- `limit` (number): Items per page (default 20)
- `page` (number): Page number (default 1)
- `search` (string): Search by name or description
- `stage` (string): Filter by stage

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_deal` (~28 tokens)

Get detailed CRM deal information by ID.

Input parameters:

- `dealId` (string, required): The deal ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_deal` (~118 tokens)

Create a CRM sales pipeline deal, optionally linked to a customer account and contact.

Input parameters:

- `accountId`: Linked CRM account ID
- `amount`: Deal amount
- `closingDate`: Expected closing date
- `contactId`: Linked contact ID
- `dealType`: Deal type/category
- `description`: Deal notes or description
- `name` (string, required): Deal name
- `ownerId`: Owner user/team member ID
- `probability`: Win probability, e.g. 25
- `stage`: Pipeline stage

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_deal` (~174 tokens)

Update a CRM deal. Pass only fields to change; use null for nullable links/fields to clear them.

Input parameters:

- `accountId`: Linked CRM account ID, or null to clear
- `amount`: Deal amount, or null to clear
- `closingDate`: Expected closing date, or null to clear
- `contactId`: Linked contact ID, or null to clear
- `dealId` (string, required): The deal ID
- `dealType`: Deal type/category, or null to clear
- `description`: Deal notes or description, or null to clear
- `name` (string): Deal name
- `ownerId`: Owner user/team member ID, or null to clear
- `probability`: Win probability, or null to clear
- `stage`: Pipeline stage, or null to clear

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_deal` (~32 tokens)

Soft-delete a CRM deal from the sales pipeline.

Input parameters:

- `dealId` (string, required): The deal ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_deal_stage` (~66 tokens)

Move a deal to a different pipeline stage.

Input parameters:

- `dealId` (string, required): The deal ID
- `lostReason` (string): Required when moving to lost
- `probability` (string): Optional win probability (percent string)
- `stage` (string, required): New pipeline stage

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `mark_deal_won` (~48 tokens)

Mark a CRM deal as won and set close date.

Input parameters:

- `closingDate` (string): Optional close date (YYYY-MM-DD)
- `dealId` (string, required): The deal ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `mark_deal_lost` (~46 tokens)

Mark a CRM deal as lost. Requires a lost reason.

Input parameters:

- `dealId` (string, required): The deal ID
- `reason` (string, required): Why the deal was lost

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `convert_lead` (~119 tokens)

Convert a lead account to an active customer. Optionally create a linked pipeline deal (Salesforce/HubSpot-style convert).

Input parameters:

- `accountId` (string, required): Lead account ID
- `createDeal` (boolean): Create a deal during conversion
- `dealAmount` (number): Optional deal amount
- `dealClosingDate` (string): Optional deal close date
- `dealName` (string): Optional deal name
- `dealStage` (string): Optional initial deal stage
- `lifeStage` (string): Lifecycle after convert (default active)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_contacts` (~62 tokens)

List contacts (people linked to CRM accounts), optionally filtered by account or search.

Input parameters:

- `accountId` (string): Filter by account
- `limit` (number): Max results (default 20)
- `search` (string): Match name, email, or phone

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_contact` (~26 tokens)

Fetch a single contact by ID.

Input parameters:

- `contactId` (string, required): The contact ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_contact` (~76 tokens)

Create a contact on an existing CRM account.

Input parameters:

- `accountId` (string, required): Owning account ID
- `email` (string): Email
- `isPrimary` (boolean): Mark as primary contact
- `jobTitle` (string): Job title
- `name` (string, required): Contact name
- `phone` (string): Phone

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_contact` (~75 tokens)

Update fields on an existing contact.

Input parameters:

- `contactId` (string, required): The contact ID
- `email` (string): Email address
- `isPrimary` (boolean): Mark as the primary contact
- `jobTitle` (string): Job title
- `name` (string): Name
- `phone` (string): Phone number

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `set_primary_contact` (~43 tokens)

Set a contact as the primary contact for its CRM account and demote other contacts on that account.

Input parameters:

- `contactId` (string, required): The contact ID to make primary

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_contact` (~41 tokens)

Delete a secondary contact. Primary contacts are protected; set another primary contact or delete the account instead.

Input parameters:

- `contactId` (string, required): The contact ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_custom_fields` (~42 tokens)

List custom field definitions for CRM entities such as account, contact, deal, or booking.

Input parameters:

- `entityType` (string, required): Entity type the custom fields belong to

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_custom_field` (~29 tokens)

Get a custom field definition by ID.

Input parameters:

- `definitionId` (string, required): Custom field definition ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_custom_field` (~130 tokens)

Create a custom field definition for CRM entities. Use options for select or multiselect fields.

Input parameters:

- `entityType` (string, required): Entity type, e.g. account, contact, deal, booking
- `fieldLabel` (string, required): Human-readable label, e.g. Preferred branch
- `fieldName` (string, required): Stable machine name, e.g. preferred_branch
- `fieldType` (string, required): Field type
- `isRequired` (boolean): Whether this field is required
- `options` (array): Allowed values for select/multiselect fields
- `sortOrder` (number): Display order

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_custom_field` (~98 tokens)

Update a custom field definition label, type, options, required flag, or sort order.

Input parameters:

- `definitionId` (string, required): Custom field definition ID
- `fieldLabel` (string): Human-readable label
- `fieldType` (string): Field type
- `isRequired` (boolean): Whether this field is required
- `options` (array): Allowed values for select/multiselect fields
- `sortOrder` (number): Display order

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_custom_field` (~31 tokens)

Delete a custom field definition and its stored values.

Input parameters:

- `definitionId` (string, required): Custom field definition ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_custom_field_values` (~50 tokens)

Get custom field values for a CRM entity such as an account, contact, deal, or booking.

Input parameters:

- `entityId` (string, required): Entity ID
- `entityType` (string, required): Entity type

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `set_custom_field_values` (~65 tokens)

Set or clear custom field values for a CRM entity. Values are stored as strings; pass null to clear a value.

Input parameters:

- `entityId` (string, required): Entity ID
- `entityType` (string, required): Entity type
- `values` (array, required): Values to upsert

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_tasks` (~74 tokens)

List tasks with optional status, assignee, and account filters.

Input parameters:

- `accountId` (string): Filter by related CRM account
- `assigneeId` (string): Filter by assignee company_members.id
- `limit` (number): Max results (default 20)
- `status` (string): Filter by task status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_task` (~26 tokens)

Get detailed task information by ID.

Input parameters:

- `taskId` (string, required): The task ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_task` (~97 tokens)

Create a task. Optionally link to a CRM account or assign to a team member.

Input parameters:

- `accountId` (string): Linked CRM account
- `assigneeId` (string): company_members.id
- `description` (string): Description
- `dueDate` (string): ISO date (YYYY-MM-DD)
- `priority` (string): Priority
- `status` (string): Status filter
- `title` (string, required): Task title

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_task` (~96 tokens)

Update a task (status, priority, assignee, due date, completion).

Input parameters:

- `assigneeId` (string): Assignee user ID
- `description` (string): Description
- `dueDate` (string): Due date (ISO 8601)
- `priority` (string): Priority
- `status` (string): Status filter
- `taskId` (string, required): The task ID
- `title` (string): Title

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_task` (~27 tokens)

Soft-delete a CRM task.

Input parameters:

- `taskId` (string, required): The task ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `search_crm` (~46 tokens)

Search across CRM accounts and contacts by name, email, or phone.

Input parameters:

- `limit` (number): Max per entity (default 10)
- `query` (string, required): Search string

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_invoices` (~91 tokens)

List invoices with optional filters. Use status "OVERDUE" to find unpaid invoices past due date.

Input parameters:

- `limit` (number): Max results (default 20)
- `order` (string): Sort order
- `search` (string): Search by invoice number, account name, email, or phone
- `sort` (string): Sort column
- `status` (string): Filter by invoice status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_invoice` (~33 tokens)

Fetch a single invoice with line items, payment history, and customer detail.

Input parameters:

- `invoiceId` (string, required): Invoice ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_invoice` (~106 tokens)

Create a new invoice for a customer. Optionally include line items inline. Returns the new invoiceId.

Input parameters:

- `accountId` (string, required): Customer accountId (CRM account)
- `currency` (string): ISO currency code (defaults to company default)
- `dueDate` (string): Due date (ISO 8601 date)
- `lineItems` (array): Line items to bill — totals are computed server-side
- `notes` (string): Free-form notes shown on the invoice

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `record_invoice_payment` (~114 tokens)

Record a manual payment against an invoice (cash, bank transfer, cheque, card terminal). Updates invoice status to PARTIAL or PAID based on the running total.

Input parameters:

- `amount` (string, required): Payment amount as decimal string, e.g. "100.00"
- `invoiceId` (string, required): Invoice ID to record payment against
- `method` (string, required): Payment method
- `note` (string): Internal note about this payment
- `reference` (string): External reference (cheque number, bank transfer ID)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `mark_invoice_sent` (~50 tokens)

Mark an invoice as sent to the customer (transitions DRAFT → OPEN). Use after delivering the invoice via email or share link. Idempotent.

Input parameters:

- `invoiceId` (string, required): Invoice ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `void_invoice` (~55 tokens)

Void an invoice. Destructive — invoice can no longer be paid or edited; existing payments are preserved as history. Cannot void invoices that are already PAID or VOIDED.

Input parameters:

- `invoiceId` (string, required): Invoice ID to void

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_invoice` (~42 tokens)

Delete a DRAFT invoice. Only invoices that have never been sent can be deleted; otherwise use void_invoice.

Input parameters:

- `invoiceId` (string, required): Invoice ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_invoice` (~28 tokens)

Restore a previously deleted DRAFT invoice.

Input parameters:

- `invoiceId` (string, required): Invoice ID to restore

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_invoice_stats` (~29 tokens)

Outstanding totals, overdue counts, and revenue this period. Used by the weekly-snapshot playbook.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_subscriptions` (~52 tokens)

List member subscriptions. Filter by status to find active, cancelled, or past-due subscriptions.

Input parameters:

- `limit` (number): Max results (default 20)
- `status` (string): Filter by subscription status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_subscription` (~34 tokens)

Fetch a single subscription with customer, tier, billing cycle, and renewal info.

Input parameters:

- `subscriptionId` (string, required): Subscription ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_subscription` (~168 tokens)

Create a recurring subscription for a member. Bind to a membership tier or set a custom amount + cycle.

Input parameters:

- `accountId` (string, required): Customer accountId
- `amount` (number): Override amount per cycle (otherwise derived from tier)
- `autoRenew` (boolean): Auto-renew at period end (default true)
- `billingCycle` (string): Billing cycle (default monthly)
- `currency` (string): ISO currency code (otherwise derived from tier or company default)
- `currentPeriodEnd` (string): Period end (ISO 8601). Defaults to start + cycle.
- `currentPeriodStart` (string): Period start (ISO 8601). Defaults to now.
- `tierId` (string): Membership tier ID — if set, amount/currency default from the tier

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `pause_subscription` (~41 tokens)

Pause an active subscription (status → past_due, no further auto-renew). Use resume_subscription to reactivate.

Input parameters:

- `subscriptionId` (string, required): Subscription ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `resume_subscription` (~26 tokens)

Resume a paused subscription back to active.

Input parameters:

- `subscriptionId` (string, required): Subscription ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `cancel_subscription` (~44 tokens)

Cancel a subscription. Destructive — turns off auto-renew and prevents further billing cycles. Existing paid periods stay valid until end.

Input parameters:

- `subscriptionId` (string, required): Subscription ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_campaigns` (~76 tokens)

List marketing campaigns (email, SMS, WhatsApp) with delivery stats.

Input parameters:

- `channel` (string): Filter by channel
- `limit` (number): Max results (default 20)
- `order` (string): Sort order
- `search` (string): Search by campaign name
- `sort` (string): Sort column

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_campaign` (~207 tokens)

Create a marketing campaign (email, SMS, or WhatsApp) in DRAFT. For email channelConfig, use subject + htmlBody + optional plainTextBody. recipientSource="list" is accepted as an alias for "individual".

Input parameters:

- `channel` (string, required): email | sms | whatsapp | push
- `channelConfig` (object): Channel-specific config: subject + htmlBody for email, body for sms/whatsapp, templateId, etc. Legacy email html is normalized to htmlBody.
- `name` (string, required): Campaign name (internal)
- `recipientIds` (array): Required if recipientSource="individual", "list", or "csv"; values are account IDs
- `recipientSource` (string): Where to source recipients from. "list" is normalized to "individual".
- `scheduledAt`: ISO datetime for scheduled send (status must be SCHEDULED)
- `segmentId`: Required if recipientSource="segment"
- `status` (string): Default DRAFT

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_campaign` (~131 tokens)

Update an existing campaign. Channel cannot be changed after creation. Pass only fields to change.

Input parameters:

- `campaignId` (string, required): Campaign ID
- `channelConfig` (object): For email, use subject + htmlBody + optional plainTextBody. Legacy html is normalized to htmlBody.
- `name` (string): Name
- `recipientIds` (array): Explicit recipient user IDs
- `recipientSource` (string): Recipient source: segment | tier | manual
- `scheduledAt`: Scheduled timestamp (ISO 8601)
- `segmentId`: Segment ID
- `status` (string): Status filter

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_campaign` (~37 tokens)

Delete a campaign. Only allowed in DRAFT status; sent campaigns are kept for audit history.

Input parameters:

- `campaignId` (string, required): Campaign ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_campaign` (~24 tokens)

Restore a previously deleted campaign.

Input parameters:

- `campaignId` (string, required): Campaign ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `validate_campaign` (~42 tokens)

Validate a campaign before sending. Resolves contactable recipient count and previews the final email subject/body without sending.

Input parameters:

- `campaignId` (string, required): Campaign ID to validate

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_notification_logs` (~123 tokens)

List notification delivery logs for the current company. Recipients are masked by default for incident-response safety.

Input parameters:

- `channel` (string): Notification channel filter
- `dateFrom` (string): ISO timestamp lower bound
- `dateTo` (string): ISO timestamp upper bound
- `entityId` (string): Entity ID filter
- `eventType` (string): Event type filter
- `limit` (number): Max results (default 50, max 100)
- `recipient` (string): Substring search on recipient
- `status` (string): Status filter

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_conversations` (~95 tokens)

List messaging conversations across WhatsApp, Messenger, Instagram, Threads, SMS, email, and other enabled channels. Threads items are public conversations. Shows unread counts and last message time.

Input parameters:

- `channel` (string): Filter by channel
- `limit` (number): Max results (default 20)
- `search` (string): Search by contact name, phone, or email
- `status` (string): Filter by conversation status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_broadcast` (~108 tokens)

Create a DRAFT WhatsApp or SMS broadcast campaign. The broadcast is NOT sent — admin must review and send it from the Broadcasts page.

Input parameters:

- `channel` (string): Channel (default whatsapp)
- `name` (string, required): Campaign name
- `recipientFilter` (object): Filter criteria for recipients, e.g. { tagIds: ["..."] }
- `scheduledAt` (string): ISO date to schedule the broadcast
- `templateId` (string): Message template ID to use

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_audit_logs` (~176 tokens)

List recent audit log entries for this company. Filter by action, resource, resourceId, user, source, outcome, destructive flag, and created date range.

Input parameters:

- `action` (string): Exact tool/action name, e.g. delete_campaign
- `createdAfter` (string): ISO timestamp lower bound
- `createdBefore` (string): ISO timestamp upper bound
- `destructive` (boolean): Whether the audited tool was destructive
- `limit` (integer): Maximum rows to return
- `outcome` (string): Execution outcome
- `resource` (string): Resource name, e.g. campaigns
- `resourceId` (string): Resource ID
- `source` (string): Audit source, e.g. mcp, ai_agent, payment_webhook, merchant_api
- `userId` (string): Actor user ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `search_audit_logs` (~77 tokens)

Search audit logs by free text across action, resource, resource ID, changes JSON, and metadata JSON.

Input parameters:

- `createdAfter` (string): ISO timestamp lower bound
- `createdBefore` (string): ISO timestamp upper bound
- `limit` (integer): Maximum rows to return
- `query` (string, required): Text to search for

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_audit_log` (~39 tokens)

Fetch a single audit log entry by ID, including before/after snapshots when available.

Input parameters:

- `auditLogId` (string, required): Audit log ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `revert_audit_action` (~63 tokens)

Revert an audited action by restoring the captured before snapshot. Only works for allowlisted target tables with full before/after audit snapshots.

Input parameters:

- `auditLogId` (string, required): Audit log ID to revert
- `reason` (string): Reason for reverting this action

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `clone` (~93 tokens)

Duplicate an existing record (product, tier, campaign, post, service package, promotion, gift offer). Creates a copy in DRAFT status with "(Copy)" appended to the name.

Input parameters:

- `entityId` (string, required): ID of the entity to clone
- `entityType` (string, required): Type of entity to clone
- `name` (string): Override the name of the cloned entity (defaults to "Original Name (Copy)")

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_notes` (~60 tokens)

List notes attached to a member/account, booking, or ticket.

Input parameters:

- `entityId` (string, required): The entity ID
- `entityType` (string, required): Type of entity the notes are on
- `limit` (number): Max results (default 10)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_note` (~68 tokens)

Add a note to a member/account, booking, ticket, or invoice.

Input parameters:

- `body` (string, required): Note content
- `entityId` (string, required): The entity ID
- `entityType` (string, required): Type of entity
- `isPinned` (boolean): Pin this note to the top

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `confirm_booking` (~26 tokens)

Confirm a pending booking.

Input parameters:

- `bookingId` (string, required): The booking ID to confirm

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `cancel_booking` (~40 tokens)

Cancel a booking. Optionally provide a reason.

Input parameters:

- `bookingId` (string, required): The booking ID to cancel
- `reason` (string): Cancellation reason

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `complete_booking` (~34 tokens)

Mark a booking as completed. Triggers commission calculation if configured.

Input parameters:

- `bookingId` (string, required): The booking ID to complete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `mark_no_show` (~38 tokens)

Mark a booking as no-show when the customer did not attend.

Input parameters:

- `bookingId` (string, required): The booking ID to mark as no-show

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_promotions` (~52 tokens)

List promotion/coupon codes with optional status filter.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by name
- `status` (string): Filter by status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_promotion` (~30 tokens)

Get details of a specific promotion/coupon code.

Input parameters:

- `promotionId` (string, required): The promotion ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_promotion` (~254 tokens)

Create a promotion / discount code. type=percentage or fixed_amount; value is the discount as a string ("10" = 10% or 10 currency units). Codes are uppercased server-side.

Input parameters:

- `bookingEnabled` (boolean): Allow on bookings
- `code` (string, required): Coupon code customers enter at checkout (auto-uppercased)
- `description` (string): Description
- `endsAt`: ISO datetime — when the promo expires
- `eventEnabled` (boolean): Allow on event registrations
- `maximumDiscount`: Cap on percentage discounts, decimal string
- `minimumAmount`: Minimum order amount required, decimal string
- `minimumQuantity`: Minimum item count required
- `name` (string, required): Promotion name (internal)
- `onlineEnabled` (boolean): Allow on online shop orders
- `posEnabled` (boolean): Allow at POS
- `startsAt`: ISO datetime — when the promo becomes valid
- `status` (string): Default active
- `type` (string): Default percentage
- `usageLimitPerCustomer`: Max uses per single customer
- `usageLimitTotal`: Max total uses across all customers
- `value` (string, required): Discount value as decimal string

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_promotion` (~132 tokens)

Update an existing promotion. Pass only the fields you want to change.

Input parameters:

- `code` (string): Promotion code
- `endsAt`: End timestamp (ISO 8601)
- `name` (string): Name
- `promotionId` (string, required): Promotion ID
- `startsAt`: Start timestamp (ISO 8601)
- `status` (string): Status filter
- `type` (string): Type
- `usageLimitPerCustomer`: Usage limit per customer
- `usageLimitTotal`: Total usage limit across all customers
- `value` (string): Discount value (numeric or decimal string)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_promotion` (~29 tokens)

Delete a promotion. Past usage records are preserved.

Input parameters:

- `promotionId` (string, required): Promotion ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_promotion` (~25 tokens)

Restore a previously deleted promotion.

Input parameters:

- `promotionId` (string, required): Promotion ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `validate_promotion` (~105 tokens)

Check if a promotion code is valid for a given order. Returns isValid, discount amount, and an error code/message if invalid. Use before applying to a checkout.

Input parameters:

- `accountId` (string): Customer account ID — used for per-customer usage limits
- `amount` (number, required): Order subtotal in major units (dollars, not cents)
- `channel` (string, required): Where the promo is being applied
- `promotionCode` (string, required): The code customer entered

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_reward_schemes` (~49 tokens)

List loyalty reward schemes (points/stamps programs) configured for this business.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by name

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_staff` (~29 tokens)

List staff/team members in the business.

Input parameters:

- `limit` (number): Max results (default 20)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_resources` (~31 tokens)

List booking resources (rooms, equipment, etc.).

Input parameters:

- `limit` (number): Max results (default 20)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_service_packages` (~87 tokens)

List service packages/prepaid session bundles with optional search, status, sorting, and pagination.

Input parameters:

- `limit` (number): Max results (default 20)
- `order` (string): Sort order
- `search` (string): Search package name
- `sort` (string): Sort column: name, price, or createdAt
- `status` (string): Filter by package status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_service_package` (~33 tokens)

Get service package detail including applicability and selected booking service/event items.

Input parameters:

- `packageId` (string, required): Service package ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_service_package` (~127 tokens)

Create a service package/prepaid session bundle. Use applicableType=SELECTED with applicableItems to limit the package to specific booking services or events.

Input parameters:

- `applicableItems` (array): Items used when applicableType=SELECTED
- `applicableType` (string): Default ALL
- `description` (string): Description
- `name` (string, required): Package name
- `price` (number, required): Package price
- `sessionCount` (integer, required): Number of included sessions
- `status` (string): Default ACTIVE
- `validDays` (integer, required): Validity window after purchase, in days

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_service_package` (~139 tokens)

Update an existing service package. Pass only the fields you want to change.

Input parameters:

- `applicableItems` (array): Item IDs the package can be redeemed against
- `applicableType` (string): What this package applies to: services | products | both
- `description`: Description
- `name` (string): Name
- `packageId` (string, required): Service package ID to update
- `price` (number): Decimal string, e.g. "80.00"
- `sessionCount` (integer): Number of sessions in the package
- `status` (string): Status filter
- `validDays` (integer): Validity period in days

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_service_package` (~29 tokens)

Delete a service package by ID.

Input parameters:

- `packageId` (string, required): Service package ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_service_package` (~31 tokens)

Restore a previously deleted service package by ID.

Input parameters:

- `packageId` (string, required): Service package ID to restore

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_plan_status` (~37 tokens)

Show the current organisation plan, subscription/payment state, enabled modules, and quota usage. Use before deciding whether an agentic operation is allowed.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `check_plan_operation` (~125 tokens)

Preflight whether an intended operation is allowed by token scopes, enabled modules, subscription state, and quota. Provide toolName, quotaCode, or moduleCode.

Input parameters:

- `delta` (integer): Planned usage increment. Currently quota checks are single-resource preflights.
- `moduleCode` (string): Module code to check, e.g. whatsapp or crm
- `quotaCode` (string): Quota code to check, e.g. contacts or mcp_calls_per_minute
- `toolName` (string): MCP tool name to preflight, e.g. create_account

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_plan_options` (~30 tokens)

List active FavCRM plans with prices, quotas, included modules, and whether each is the current plan.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_plan_upgrade_link` (~141 tokens)

Create a Stripe Checkout link for a new paid subscription, or a Stripe Billing Portal link for an existing Stripe subscription. Use only after the user explicitly asks to upgrade or fix billing.

Input parameters:

- `billingCycle` (string)
- `confirm` (boolean): Required true to create a Stripe-hosted payment or billing link.
- `planCode` (string): Target plan code, e.g. favcrm-lite. Either planId or planCode is required.
- `planId` (string): Target plan ID. Use list_plan_options first if unknown.
- `returnUrl` (string): Where Stripe should return after checkout/portal. Defaults to merchant billing settings.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_team_member_invite` (~149 tokens)

Invite a team member to this company and return a one-time MCP accept token. The invited user must verify an email code through accept_team_invite_request and accept_team_invite_verify before membership and API key issuance.

Input parameters:

- `email` (string, required): Invitee email address
- `expiresInHours` (integer): Invite lifetime in hours. Defaults to 72, max 336.
- `modules` (array): Optional legacy module list to attach to the company member
- `name` (string): Optional display name for a new user
- `permissions` (array): Optional structured module permissions to attach to the company member
- `role` (string): Team member role to grant on acceptance

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `accept_team_invite_request` (~79 tokens)

Step 1 of agentic team invite acceptance. Validates an invite token and sends a 6-digit verification code to the invited email. Then call accept_team_invite_verify with the code to join and receive an MCP API key.

Input parameters:

- `token` (string, required): Invite token returned by create_team_member_invite or from the invite link

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `accept_team_invite_verify` (~98 tokens)

Step 2 of agentic team invite acceptance. Verifies the emailed code, joins the invited user to the company, and returns a one-time MCP API key for that user.

Input parameters:

- `code` (string, required): 6-digit code from the invite email
- `name` (string): Optional display name when creating a new user
- `token` (string, required): Invite token returned by create_team_member_invite or from the invite link

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_whatsapp_connection_status` (~37 tokens)

Check whether WhatsApp Business is connected for this company, including WABA/phone metadata and the latest agentic connect session state.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_whatsapp_connect_link` (~96 tokens)

Create a short-lived browser link for WhatsApp Business Embedded Signup. The user must open the link because Meta requires a browser popup to authorize and choose the WABA/phone number.

Input parameters:

- `onboardingMode` (string): Use cloud_api for a new WhatsApp Cloud API connection, or coexistence when connecting a WhatsApp Business App number.
- `ttlMinutes` (integer): Connect link lifetime in minutes. Defaults to 30.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_my_companies` (~33 tokens)

List all companies/organisations the current user has access to. Use this to see available orgs before switching.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `switch_company` (~65 tokens)

Switch the current session to a different company/organisation. Returns a new access token scoped to the target company. All subsequent tool calls will operate on the new company.

Input parameters:

- `companyId` (string, required): The company ID to switch to (use list_my_companies to find available IDs)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_posts` (~82 tokens)

List CMS posts (blog posts and/or pages) with optional filters.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by title
- `status` (string): Filter by status
- `type` (string): Filter by post type slug (blog_post, page, or any custom type — see list_post_types).

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_post` (~32 tokens)

Get detailed CMS post including content blocks, categories, and tags.

Input parameters:

- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_post` (~428 tokens)

Create a new CMS post (blog_post, page, or any custom post type). The post type must already exist — use list_post_types to discover, create_post_type to add a new one. excerpt = plain-text summary only (auto-derived from blocks if omitted). Structured custom fields go in meta, keyed by the field schema defined with create_post_type_field.

Input parameters:

- `blocks` (array): Ordered array of content blocks. Each block has { id, version, type, data } where type is one of: paragraph, heading, image, list, quote, code, divider, spacer, embed, html, youtube, file, faq, callo…
- `categoryIds` (array): Category IDs (post types with supportsCategories only)
- `excerpt` (string): Plain-text summary only — never JSON. Auto-derived from the first paragraph/heading block if omitted and the post type supports excerpts.
- `featuredImage` (string): Cover image URL
- `meta` (object): Structured custom field values, keyed by field key (see list_post_type_fields). Validated against the post type field schema. Use this for all machine-readable data — never put JSON in excerpt.
- `parentId`: Parent post ID for nested types (e.g. pages).
- `publishedAt`: ISO timestamp; required when status=scheduled.
- `seoDescription` (string): SEO meta description
- `seoTitle` (string): SEO title override
- `slug` (string): URL slug. Auto-generated from title if omitted; collisions get -2, -3 suffix.
- `sortOrder` (number): Sort order (lower = earlier)
- `status` (string): Status (default draft)
- `tagIds` (array): Tag IDs to attach to the post
- `title` (string, required): Post title
- `type` (string, required): Post type slug (e.g. blog_post, page, treatment). Must exist in post_types for this company.
- `visibility` (string): Visibility (default public)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_post` (~343 tokens)

Update an existing CMS post (any post type). Only provided fields are changed.

Input parameters:

- `blocks` (array): Replaces the entire ordered block array. Use append_post_block / replace_post_block / remove_post_block / reorder_post_blocks for per-block edits. Each block: { id, version, type, data }. Types: para…
- `categoryIds` (array): Category IDs
- `excerpt` (string): Plain-text summary only — never JSON. Omit to leave unchanged.
- `featuredImage` (string): Cover image URL
- `meta` (object): Custom field values; merged shallowly with existing meta. Use this for structured data, not excerpt.
- `parentId`: Parent post ID for nested types.
- `postId` (string, required): The post ID
- `publishedAt`: Publish timestamp (ISO 8601)
- `seoDescription` (string): SEO description override
- `seoTitle` (string): SEO title override
- `slug` (string): URL slug (must be unique per company+type).
- `sortOrder` (number): Sort order (lower = earlier)
- `status` (string): Post status
- `tagIds` (array): Tag IDs to sync (replaces existing tags)
- `title` (string): Post title
- `type` (string): Change post type (e.g. blog_post → treatment). Slug is re-checked for uniqueness under the new type.
- `visibility` (string): Visibility

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_post` (~37 tokens)

Delete a CMS post by ID. Soft-deleted posts can be restored with restore_post.

Input parameters:

- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_post` (~26 tokens)

Restore a previously deleted CMS post.

Input parameters:

- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_image_models` (~41 tokens)

List AI image-generation models exposed to merchants (sanitized — provider/cost details hidden). Use to pick a `modelCode` for `generate_post_cover`.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `generate_image` (~191 tokens)

Generate an AI image via kie.ai and return its public R2 URL. Use to mint reusable URLs for content blocks (image, gallery), product photos, or any field that takes an image URL — does NOT attach to a post by itself. Costs credits (see list_image_models). On poll timeout the job continues running; pass `jobId` from the response to merchant ai-media APIs to retrieve it later.

Input parameters:

- `aspectRatio` (string): Output aspect ratio (e.g. 16:9, 1:1)
- `modelCode` (string, required): Image model code from list_image_models
- `negativePrompt` (string): Things to exclude from generation
- `pollIntervalMs` (integer): Default 3000.
- `pollTimeoutMs` (integer): Default 60000.
- `prompt` (string, required): Generation prompt
- `seed` (integer): Random seed for reproducible output

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `generate_post_cover` (~217 tokens)

Generate an AI image and attach it as a post's featuredImage. Submits a kie.ai job, polls until complete, copies the result into the canonical post-asset R2 folder, and writes the public URL onto the post. Costs credits (see list_image_models). On poll timeout, the job continues — call attach_post_cover_from_job(postId, jobId) once it finishes to attach without paying again.

Input parameters:

- `aspectRatio` (string): Aspect ratio passed to the model, e.g. "16:9", "1:1"
- `modelCode` (string, required): Image model code from list_image_models (e.g. nano-banana-2)
- `negativePrompt` (string): Things to exclude from generation
- `pollIntervalMs` (integer): Default 3000.
- `pollTimeoutMs` (integer): Default 60000.
- `postId` (string, required): The post ID
- `prompt` (string, required): Image generation prompt
- `seed` (integer): Random seed for reproducible output

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `attach_post_cover_from_job` (~193 tokens)

Attach a previously generated ai-media job's output as the post's featuredImage. Use when generate_post_cover timed out (job kept running) or when reusing the same generation across multiple posts. Verifies the job belongs to your company and succeeded. Does NOT charge credits — credits were charged at submit time.

Input parameters:

- `assetIndex` (integer): Which asset to use when the job produced multiple outputs. Default 0.
- `jobId` (string, required): The ai-media job ID (from generate_image, generate_post_cover, or POST /v6/merchant/ai-media/generate)
- `pollIfRunning` (boolean): When true, advance polling once if the job is still running. Default true.
- `pollTimeoutMs` (integer): When pollIfRunning is true, wait up to this long for terminal state. Default 30000.
- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `upload_post_cover_from_url` (~115 tokens)

Download an external image URL into R2 and attach it as the post's featuredImage. Replaces the manual flow of pasting external URLs (which break when the source goes down). Validates content-type starts with `image/` and rejects payloads larger than 20 MB. No AI credits charged — only standard storage.

Input parameters:

- `postId` (string, required): The post ID
- `sourceUrl` (string, required): Public http(s) URL to fetch the image from. Must respond with an image/* content-type.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_categories` (~13 tokens)

List CMS post categories.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_category` (~84 tokens)

Create a CMS post category (e.g. "Equipment", "Injection — Botox"). For sub-categories, use namespaced names — the table is flat.

Input parameters:

- `description` (string): Description
- `name` (string, required): Category name
- `slug` (string): Auto-generated from name if omitted.
- `sortOrder` (number): Sort order (lower = earlier)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_category` (~61 tokens)

Update a CMS post category.

Input parameters:

- `categoryId` (string, required): Category ID
- `description`: Description
- `name` (string): Name
- `slug` (string): URL slug
- `sortOrder` (number): Sort order (lower = earlier)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_category` (~38 tokens)

Delete a CMS post category. Posts in the category are not deleted; they are simply unlinked.

Input parameters:

- `categoryId` (string, required): Category ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_category` (~26 tokens)

Restore a previously deleted CMS post category.

Input parameters:

- `categoryId` (string, required): Category ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_post_types` (~31 tokens)

List all post types defined for this company (built-in: blog_post, page; plus any custom types).

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_post_type` (~204 tokens)

Define a new custom post type (e.g. "treatment", "service"). Required before creating posts of that type. After creating a post type, use create_post_type_field to define its structured field schema. Those fields are stored in meta on each post — do not use excerpt for structured data.

Input parameters:

- `icon`: Icon name or URL
- `label` (string, required): Singular UI label, e.g. "Treatment"
- `labelPlural` (string, required): Plural UI label, e.g. "Treatments"
- `slug` (string, required): Lowercase identifier, e.g. "treatment". Auto-derived from label if omitted.
- `sortOrder` (number): Sort order (lower = earlier)
- `supportsBlocks` (boolean): Default true
- `supportsCategories` (boolean): Default true
- `supportsExcerpt` (boolean): Default true
- `supportsFeaturedImage` (boolean): Default true
- `supportsNesting` (boolean): Default false

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_post_type_fields` (~56 tokens)

List the custom field schema for a post type. Use this before creating posts to know which keys to pass in meta and what types they expect.

Input parameters:

- `postTypeId` (string, required): Post type ID (from list_post_types)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_post_type_field` (~287 tokens)

Add a custom field to a post type schema. The field key becomes the key in meta when creating/updating posts. Use fieldType="repeater" with fields=[...] for repeatable structured rows. Use this instead of storing structured data in excerpt.

Input parameters:

- `fieldType` (string, required): Field type: text | textarea | richtext | number | boolean | date | datetime | select | multiselect | url | email | image | file | gallery | attachments | repeater
- `fields` (array): Required for fieldType="repeater". Defines the child fields stored in each row object.
- `helpText` (string): Optional hint shown in the UI
- `key` (string): snake_case key used in meta. Auto-derived from label if omitted.
- `label` (string, required): Human-readable field label, e.g. "Tagline"
- `options` (object): For select/multiselect: { choices: [{ label, value }] }. For URL fields that should accept merchant uploads, use { uploadable: true } so the UI stores the uploaded file URL instead of asking the merc…
- `postTypeId` (string, required): Post type ID (from list_post_types)
- `required` (boolean): Whether the field is required on post creation (default false)
- `sortOrder` (number): Sort order (lower = earlier)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_post_type` (~151 tokens)

Update a custom post type. Built-in types (blog_post, page) cannot be modified.

Input parameters:

- `icon`: Icon name or URL
- `label` (string): Display label
- `labelPlural` (string): Plural display label
- `postTypeId` (string, required): Post type ID
- `sortOrder` (number): Sort order (lower = earlier)
- `supportsBlocks` (boolean): Allow content blocks (rich body)
- `supportsCategories` (boolean): Allow categories on this post type
- `supportsExcerpt` (boolean): Allow an excerpt field
- `supportsFeaturedImage` (boolean): Allow a featured image
- `supportsNesting` (boolean): Allow parent/child nesting

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_post_type` (~49 tokens)

Delete a custom post type. Built-in types cannot be deleted. Fails if any posts of this type still exist — delete those first.

Input parameters:

- `postTypeId` (string, required): Post type ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_post_type` (~29 tokens)

Restore a previously deleted custom post type.

Input parameters:

- `postTypeId` (string, required): Post type ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_post_type_field` (~187 tokens)

Update a field on a post type schema. Changing fieldType or flipping required=true is blocked when posts already use the field unless force=true is passed.

Input parameters:

- `fieldId` (string, required): Field ID
- `fieldType` (string): Field type
- `fields`: Child fields for fieldType="repeater".
- `force` (boolean): Override safety guards. Required to change fieldType or flip required=true on a field that already has data in posts.
- `helpText`: Help text shown next to the input
- `label` (string): Display label
- `options`: For URL fields, { uploadable: true } enables file upload while preserving a URL string in meta.
- `postTypeId` (string, required): Post type ID
- `required` (boolean): Whether the field is required
- `sortOrder` (number): Sort order (lower = earlier)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_post_type_field` (~88 tokens)

Remove a field from a post type schema. Blocked when posts of this type still have data in the field unless force=true is passed (orphans the data).

Input parameters:

- `fieldId` (string, required): Field ID
- `force` (boolean): Delete even if posts have data in this field. Existing meta values become orphaned.
- `postTypeId` (string, required): Post type ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_post_type_field` (~43 tokens)

Restore a previously deleted field on a post type schema.

Input parameters:

- `fieldId` (string, required): Field ID
- `postTypeId` (string, required): Post type ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `reorder_post_type_fields` (~61 tokens)

Reorder fields on a post type. Pass field IDs in the desired display order; sortOrder is updated to match.

Input parameters:

- `orderedFieldIds` (array, required): Field IDs in the desired order
- `postTypeId` (string, required): Post type ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `append_post_block` (~102 tokens)

Append one or more blocks to the end of a post. Each block must be a valid block object: { id, version, type, data }. Types: paragraph, heading, image, list, quote, code, divider, spacer, embed, html, youtube, file, faq, callout, gallery, cta, accordion, product.

Input parameters:

- `blocks` (array, required): Block(s) to append
- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `replace_post_block` (~71 tokens)

Replace a single block at the given index (0-based). Avoids fetching the full post and re-sending all blocks via update_post.

Input parameters:

- `block` (required): Replacement block
- `index` (integer, required): 0-based index of the block to replace
- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `remove_post_block` (~55 tokens)

Remove the block at the given index (0-based). All subsequent blocks shift up by one.

Input parameters:

- `index` (integer, required): 0-based index of the block to remove
- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `reorder_post_blocks` (~66 tokens)

Reorder blocks by passing block IDs in the desired order. The id list must contain every existing block id exactly once.

Input parameters:

- `orderedBlockIds` (array, required): Block IDs in the desired order; must match the existing set exactly
- `postId` (string, required): The post ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_booking` (~138 tokens)

Create a new booking for a member. Use get_available_slots first to find valid times, then create the booking with the service, member, date, and time.

Input parameters:

- `accountId` (string, required): The member/account ID
- `bookingDate` (string, required): Date in YYYY-MM-DD format
- `endTime` (string, required): End time in HH:MM format
- `notes` (string): Booking notes
- `resourceId` (string): Resource ID
- `serviceId` (string, required): The service ID
- `staffId` (string): Staff member ID
- `startTime` (string, required): Start time in HH:MM format

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_conversation_messages` (~63 tokens)

Get messages from a specific conversation thread. Shows the chat history between the merchant and a contact.

Input parameters:

- `conversationId` (string, required): The conversation ID
- `limit` (number): Max results (default 20)
- `search` (string): Search within messages

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `find_or_create_workroom_thread` (~107 tokens)

Find or create a Workroom DM thread between a merchant user and an AI colleague. Use this when an inbound event deserves owner attention but no threadId was provided. This only prepares an internal Workroom channel.

Input parameters:

- `agentId` (string, required): AI colleague ID for the Workroom DM
- `title` (string): Optional title if a new thread is created
- `userId` (string): Merchant user ID to notify. Defaults to the current MCP user when omitted.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_attachment_text` (~99 tokens)

Read the text/Markdown content of a file attached to a Workroom thread or sent by a customer (PDF, image, or document). Extracts on first read and caches the result. Returns status "ready" with markdown, or "skipped"/"failed"/"not_found" with a reason. Use when a message references an attachment you need to read.

Input parameters:

- `attachmentId` (string, required): The attachment ID from the message attachments list

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `post_workroom_message` (~132 tokens)

Post an internal message from an AI colleague into a Workroom thread. Use this to report findings, ask the owner for approval, or share source links after reading CRM/Inbox data. This does not send anything to customers.

Input parameters:

- `agentId` (string, required): AI colleague ID that is a participant in the thread
- `content` (string, required): Message to show in Workroom. Markdown is allowed.
- `metadata` (object): Optional generic metadata, e.g. {sourceRefs:[{type:"inbox_conversation",id:"..."}]}
- `threadId` (string, required): Workroom thread ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_inbox_reply_suggestion` (~135 tokens)

Create a draft reply suggestion that appears inline in the FavCRM Inbox composer. Use this for message.inbound events with replyPolicy="suggest"; it does not send anything to the customer.

Input parameters:

- `agentId` (string, required): AI colleague ID creating the suggestion
- `body` (string, required): Draft reply text for the merchant to review
- `conversationId` (string, required): Inbox conversation ID
- `metadata` (object): Optional metadata such as rationale, confidence, or source refs
- `sourceMessageId` (string): Inbound message ID this draft responds to
- `subject` (string): Optional email subject suggestion

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `request_send_approval` (~136 tokens)

Create a merchant-owned Workroom approval request for a customer-facing send. The agent must not call send_message, send_whatsapp_message, send_test_campaign, or send_campaign directly.

Input parameters:

- `actionType` (string, required): The customer-facing action to execute only after merchant approval
- `agentId` (string, required): AI colleague ID that is a participant in the thread
- `payload` (object, required): Exact tool payload to execute if the merchant approves
- `summary` (string, required): Human-readable draft/recipient/campaign summary shown above the approval buttons
- `threadId` (string, required): Workroom thread ID where the approval button should appear

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_segments` (~46 tokens)

List customer segments. Segments group members by criteria for targeted campaigns.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by segment name

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_segment` (~33 tokens)

Get customer segment details including type, criteria, and live member count.

Input parameters:

- `segmentId` (string, required): The segment ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_segment_members` (~43 tokens)

Get the members that belong to a specific segment.

Input parameters:

- `limit` (number): Max results (default 20)
- `segmentId` (string, required): The segment ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_segment` (~72 tokens)

Create a new customer segment. Use STATIC for manual member lists, DYNAMIC for criteria-based auto-filtering.

Input parameters:

- `criteria` (object): Dynamic segment criteria
- `description` (string): Segment description
- `name` (string, required): Segment name
- `segmentType` (string): Segment type (default DYNAMIC)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_segment` (~87 tokens)

Update an existing customer segment by id. Pass only the fields to change; criteria replaces the existing rules.

Input parameters:

- `criteria`: Replace dynamic criteria, or null to clear criteria
- `description` (string): New segment description
- `name` (string): New segment name
- `segmentId` (string, required): The segment ID to update
- `segmentType` (string): Change segment type

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `preview_segment_count` (~44 tokens)

Preview how many customers would match dynamic segment criteria before creating or updating a segment.

Input parameters:

- `criteria`: Dynamic criteria to preview. Omit or null to count all active customers.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `set_segment_members` (~57 tokens)

Replace the members of a STATIC customer segment with the given account IDs. The segment is converted to STATIC.

Input parameters:

- `accountIds` (array, required): CRM account IDs to set as segment members
- `segmentId` (string, required): The segment ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_segment` (~26 tokens)

Delete a customer segment.

Input parameters:

- `segmentId` (string, required): The segment ID to delete

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_templates` (~61 tokens)

List the company's WhatsApp message templates with their Meta approval status (PENDING / APPROVED / REJECTED). Check this to see which templates are approved before referencing one in a campaign.

Input parameters:

- `limit` (integer): Max templates to return (default 20)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_template` (~200 tokens)

Create and submit a WhatsApp message template to Meta for approval. Text templates only (header text, body with {{1}} variables, footer) — add buttons in the app. The template is NOT usable until Meta approves it (check with list_templates). Submitting consumes the store’s Meta template allowance.

Input parameters:

- `category` (string, required): UTILITY = transactional (order/shipping), MARKETING = promos, AUTHENTICATION = codes.
- `footer` (string): Optional small footer text.
- `headerText` (string): Optional short bold header above the body.
- `language` (string): Language code, default en_US.
- `message` (string, required): Body text. Use {{1}}, {{2}} for personalised values.
- `name` (string, required): Friendly template name (a Meta-safe id is derived from it).
- `variableSamples` (object): Example values per variable number, e.g. {"1":"Sara"} — Meta reviews with these.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_outlets` (~36 tokens)

List shop outlets/locations for the company.

Input parameters:

- `activeOnly` (boolean): When true, only return active outlets (default false)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_outlet` (~135 tokens)

Create a shop outlet/location. Optionally pass id to preserve a legacy UUID during migration.

Input parameters:

- `acceptsOrders` (boolean): Whether outlet accepts online orders (default true)
- `address`: Street address
- `id` (string): Optional outlet UUID (for legacy migration; non-standard formats accepted)
- `isActive` (boolean): Whether outlet is active (default true)
- `latitude`: Latitude
- `logoUrl`: Logo URL
- `longitude`: Longitude
- `name` (string, required): Outlet name
- `phone`: Contact phone
- `sortOrder` (integer): Display sort order (default 0)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_outlet` (~108 tokens)

Update an existing shop outlet/location by ID.

Input parameters:

- `acceptsOrders` (boolean): Whether outlet accepts online orders
- `address`: Street address
- `id` (string, required): Outlet ID (UUID)
- `isActive` (boolean): Whether outlet is active
- `latitude`: Latitude
- `logoUrl`: Logo URL
- `longitude`: Longitude
- `name` (string): Outlet name
- `phone`: Contact phone
- `sortOrder` (integer): Display sort order

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_products` (~68 tokens)

List shop products with optional filters by name, status, or category.

Input parameters:

- `categoryId` (number): Filter by category ID
- `limit` (number): Max results (default 20)
- `search` (string): Search by product name
- `status` (string): Filter by status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_product` (~31 tokens)

Get full product detail including images, options, and variations.

Input parameters:

- `productId` (number, required): The product ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_product` (~122 tokens)

Create a new shop product as DRAFT. Merchant can review and activate from the portal.

Input parameters:

- `categoryIds` (array): Category IDs (first is primary)
- `description` (string): Product description
- `discountPrice` (string): Discounted price
- `memberPrice` (string): Members-only price
- `name` (string, required): Product name
- `price` (string, required): Price as decimal string (e.g. "29.99")
- `productType` (string): Product type (default one_time)
- `sku` (string): SKU code

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_product` (~119 tokens)

Update an existing product. Only provided fields are changed.

Input parameters:

- `categoryIds` (array): Category IDs (first is primary). Replaces all existing categories.
- `description` (string): Product description
- `discountPrice` (string): Discounted price
- `memberPrice` (string): Members-only price
- `name` (string): Product name
- `price` (string): Price as decimal string
- `productId` (number, required): The product ID
- `sku` (string): SKU code
- `status` (string): Product status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_product_categories` (~17 tokens)

List all product categories for the shop.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_product_category` (~84 tokens)

Create a product category. Use parentId to create subcategories under an existing category.

Input parameters:

- `description` (string): Category description
- `name` (string, required): Category name
- `onlineEnabled` (boolean): Show in online store (default true)
- `parentId` (number): Parent category ID for subcategories
- `sortOrder` (number): Display sort order

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_variation` (~132 tokens)

Add a variation (size, color, etc.) to an existing product.

Input parameters:

- `discountPrice` (string): Discounted price
- `memberPrice` (string): Members-only price
- `name` (string): Variation name
- `price` (string, required): Price as decimal string (e.g. "29.99")
- `productId` (number, required): The product ID
- `selectedOptions` (object): Option selections e.g. {"Size": "Large"}
- `sku` (string): Variation SKU
- `stockQuantity` (number): Stock quantity
- `stockStatus` (string): Stock status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_orders` (~57 tokens)

List shop orders with optional status and search filters.

Input parameters:

- `limit` (number): Max results (default 20)
- `search` (string): Search by order number or customer name/email
- `status` (string): Filter by order status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_order` (~27 tokens)

Get full order detail including line items.

Input parameters:

- `orderId` (string, required): The order UUID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `update_order_status` (~47 tokens)

Update the status of a shop order (e.g. confirm, ship, cancel).

Input parameters:

- `orderId` (string, required): The order UUID
- `status` (string, required): New order status

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_offer_rules` (~56 tokens)

List upsell/cross-sell offer rules with optional filters.

Input parameters:

- `limit` (number): Max results (default 20)
- `status` (string): Filter by status
- `type` (string): Filter by rule type

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_offer_rule` (~31 tokens)

Get offer rule detail including associated products and discounts.

Input parameters:

- `ruleId` (string, required): The offer rule ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `create_offer_rule` (~110 tokens)

Create an upsell/cross-sell offer rule as draft. Specify trigger type, conditions, and suggested products with optional discounts.

Input parameters:

- `description` (string): Rule description
- `name` (string, required): Rule name
- `products` (array): Products to suggest with optional discounts
- `triggerConfig` (object): Trigger-specific configuration
- `triggerType` (string, required): When the offer triggers
- `type` (string, required): Rule type: upsell, cross_sell, bundle, or post_purchase

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `query_favcrm_platform` (~92 tokens)

Search FavCRM MCP tools, enabled skills, and feature areas for how to use the platform. Use before guessing tool names or JSON arguments.

Input parameters:

- `area` (string): Restrict search area (default all)
- `limit` (integer): Maximum results (default 8)
- `query` (string, required): Plain-language capability question, e.g. "create a booking" or "send a campaign safely"

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `search_tools` (~144 tokens)

Search the available FavCRM tool catalog for relevant operations. Use this when the curated direct tool list does not contain the operation you need.

Input parameters:

- `includeInputSchema` (boolean): Include full JSON input schemas for returned tools. Defaults to false to keep context small.
- `limit` (integer): Maximum results (default 8, max 20)
- `query` (string): Plain-language tool search, e.g. "delete a segment" or "set custom field values"
- `scope` (string): Optional exact scope filter, e.g. contacts, customer_segments, invoices
- `write` (boolean): Filter to write tools (true) or read-only tools (false)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `execute_tool` (~76 tokens)

Execute an available FavCRM tool by name after discovering it with search_tools. Target tool availability, input schema, module gates, and audit logging are still enforced.

Input parameters:

- `arguments` (object): Arguments object for the target tool. Must match the target input schema.
- `toolName` (string, required): Exact target tool name returned by search_tools

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `query_company_knowledge` (~90 tokens)

Search this company's reviewed knowledge base and return grounded snippets with source document IDs. Use for merchant policies, FAQs, pricing notes, brand guidance, and other uploaded references.

Input parameters:

- `limit` (integer): Maximum matching snippets (default 5)
- `maxSnippetChars` (integer): Maximum characters per snippet (default 600)
- `query` (string, required): Question or keywords to search for in company knowledge

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_knowledge_documents` (~112 tokens)

List merchant knowledge base documents (uploads + scraped URLs). Use reviewStatus/syncable to see what is ready for agent retrieval. Pass `updatedAfter` for delta sync. Reviewed content is fetched via GET /v6/merchant/ai/knowledge/{id}/content; source audit text is available with ?variant=extracted.

Input parameters:

- `limit` (number): Max results (default 100)
- `updatedAfter` (string): ISO timestamp — only return docs updated after this. Use for delta sync.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `get_knowledge_document` (~62 tokens)

Fetch a single knowledge document with metadata + extraction/review status. Reviewed content is served via GET /v6/merchant/ai/knowledge/{id}/content; raw/extracted variants are for audit.

Input parameters:

- `documentId` (string, required): Knowledge document ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `scrape_knowledge_url` (~88 tokens)

Fetch a URL's content into the knowledge base. Server crawls the URL, stores the response body in R2, returns the new document ID. Failures store the row with status='failed'. Use for adding marketing pages, FAQ docs, or external references the agent should be aware of.

Input parameters:

- `url` (string, required): URL to fetch (must be https / http and publicly reachable)

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `add_knowledge_text` (~82 tokens)

Add a free-form text document to the knowledge base. Use for pasted policies, FAQs, internal notes, brand voice references — anything the agent should be able to retrieve later. Stored as a single document; agent-side embedding/retrieval happens elsewhere.

Input parameters:

- `content` (string, required): Document body text
- `name` (string, required): Friendly title for the document

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `delete_knowledge_document` (~45 tokens)

Soft-delete a knowledge document. The agent loses access immediately, but the document can be restored with restore_knowledge_document.

Input parameters:

- `documentId` (string, required): Knowledge document ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `restore_knowledge_document` (~28 tokens)

Restore a previously deleted knowledge document.

Input parameters:

- `documentId` (string, required): Knowledge document ID

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `list_shipping_methods` (~18 tokens)

List all shipping methods configured for the shop.

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `report_agent_issue` (~264 tokens)

Report a FavCRM platform issue when an agent finds a missing MCP path, tool failure, confusing schema, CLI/docs issue, or SDK fallback. Include logs, AI analysis, references, and clarification questions so the platform team can follow up.

Input parameters:

- `actualBehavior` (string, required): What actually happened
- `aiAnalysis` (string, required): Agent analysis of likely root cause and impact
- `area` (string, required): Issue area
- `clarificationQuestions` (array): Questions the platform team should ask the agent/user to resolve ambiguity
- `environment` (object): Runtime context such as MCP URL, CLI version, token type, client, sandbox, model, OS
- `expectedBehavior` (string, required): What the agent or user expected to happen
- `logs` (array): Relevant error messages, command output, or stack traces
- `references` (array): Source links, file paths, docs, screenshots, or IDs that support the report
- `severity` (string, required): Impact level
- `stepsTried` (array, required): Concrete steps the agent tried before reporting
- `title` (string, required): Short issue title
- `toolCalls` (array): Relevant MCP/CLI/SDK calls, arguments, and outcomes
- `workaround` (string): Temporary workaround used, if any

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `register_organisation_request` (~172 tokens)

Step 1 of agentic signup. Sends a 6-digit verification code to the email. After the user reads the code, call register_organisation_verify with it to finish and receive an API key. Use this when a user wants to create a new FavCRM workspace from inside an MCP client.

Input parameters:

- `country` (string): ISO 3166-1 alpha-2 country code (HK, US, GB, ...)
- `email` (string, required): Owner email — receives a 6-digit code (10 min TTL)
- `industry` (string): Vertical — drives default templates
- `organisationName` (string, required): Business / brand name (used as the first company name too)
- `timezone` (string): IANA timezone (e.g. Asia/Hong_Kong); falls back to country default

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

### `register_organisation_verify` (~86 tokens)

Step 2 of agentic signup. Confirms the 6-digit code and creates the workspace. Returns an API key the agent should set as Authorization: Bearer <apiKey> for all subsequent FavCRM MCP calls in this session.

Input parameters:

- `code` (string, required): 6-digit code from the verification email
- `requestId` (string, required): From register_organisation_request

Output parameters:

- `data`: Tool result payload — shape varies per tool, see the tool description
- `renderType` (string): UI rendering hint for the result
- `summary` (string): One-line human-readable summary of the action

## Diagnostics

Captured diagnostic sections: TLS, DNSSEC, Authorisation, Transports. The full working is on the page: https://verifymcp.io/servers/io-favcrm-favcrm/api#diagnostics

## Score history

- 2026-08-03: 82
- 2026-08-02: 81
- 2026-08-01: 81
- 2026-07-31: 80
- 2026-07-30: 76
- 2026-07-29: 76
- 2026-07-28: 75
- 2026-07-27: 74
- 2026-07-26: 74

## Links

- Remote endpoint: https://api.favcrm.io/mcp
- Repository: https://github.com/favcrm/mcp
- Website: https://favcrm.io/
- Changelog RSS feed: https://verifymcp.io/servers/io-favcrm-favcrm/api/changelog.xml
- Changelog JSON feed: https://verifymcp.io/servers/io-favcrm-favcrm/api/changelog.json
- HTML version of this page: https://verifymcp.io/servers/io-favcrm-favcrm/api