Activity Messenger Help Center

MCP action and tool catalogue

Browse the registered Activity Messenger capabilities before connecting an AI client. This generated reference contains 198 business actions, 173 distinct MCP tools, and 15 additional workflow helpers included in that tool count. Several actions share one dispatcher.

See Connect an AI assistant with MCP for connection setup and the review workflow. Use your browser’s Find command to search an action ID, tool name or input field, or jump to a module below.

Access and execution

This is a documentation reference for the registered capability set, using an all-permissions profile. It grants no access and is not the list available to every account. Active organization modules, current user permissions, credential scope and native availability rules determine actual access. Use MCP tools/list, discover_application_actions and get_application_action for the live permitted contracts.

Every action requires assistant access. Permission labels below summarize the domain gate; the native action may impose additional ownership, module, state and confirmation checks. Read-only credentials expose only the supported subset. Full-catalogue credentials require --allow-changes and do not bypass AM permissions.

Input lists contain top-level native fields. Read the live schema for nested objects, types, enums and constraints. Contextual calls additionally require am_session_id, am_run_id and a unique am_call_id; the tool’s transport schema determines when they are mandatory. Interface actions share request_application_task; include the selected action_id, a confirmed goal and task_kind, then open the returned AM page.

“Prepare a change” creates an immutable proposal. apply_assistant_draft requests human review in AM; MCP cannot approve its own changes. Editor actions use native confirmations. Drafts and charts have their own native workflows. A pending or queued state is not completion.

This snapshot was generated from the shared registry and MCP adapter; see the live schemas whenever they differ. Regenerate this reference when those contracts change.

Browse by module

Attendance

attendance.add_participant

Add a class participant.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Participant-addition permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

attendance.checkin

Check in a participant.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Attendance. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

attendance.read

Read class attendance.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Attendance. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

attendance.update

Update class attendance.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Attendance. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Automations

automation.audiences

Find workflow audiences.

  • Tool: list_automation_audiences.

  • Execution: Read.

  • Permissions: Automations permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

automation.conditions

Edit automation conditions.

  • Tool: prepare_automation_conditions.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: automation_id, changes.

automation.instant_message

Configure instant confirmations.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

automation.list

List workflows.

  • Tool: list_automations.

  • Execution: Read.

  • Permissions: Automations permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

automation.native

Edit native automation settings.

  • Tool: prepare_automation_settings.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: automation_id, changes.

automation.save

Create or update an email workflow.

  • Tool: prepare_automation_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, type, recipient_list_id, days_before, time, use_bot, subject, body, message_both_parents.

  • Optional inputs: automation_id, description.

automation.sequence

Set up a follow-up sequence.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

automation.settings_read

Read automation settings.

  • Tool: get_automation_settings.

  • Execution: Read.

  • Permissions: Automations permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: automation_id.

automation.sms

Edit SMS automation.

  • Tool: prepare_automation_sms.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Automations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: automation_id, changes.

Bookings

bookings.addons

Configure booking add-ons.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Bookings. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

bookings.availability

Check booking availability.

  • Tool: check_booking_availability.

  • Execution: Read.

  • Permissions: Bookings permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: events.

bookings.cancel

Cancel a local reservation.

  • Tool: prepare_booking_cancel.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Bookings. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: booking_id, reason.

bookings.create

Create a local reservation.

  • Tool: prepare_booking_create.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Bookings. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, notes, booking_type_id, events.

bookings.packages

Configure booking packages.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Bookings. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

bookings.read

Read a booking.

  • Tool: get_booking_details.

  • Execution: Read.

  • Permissions: Bookings permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: booking_id.

bookings.setup_read

Check booking form prerequisites.

  • Tool: get_booking_setup_context.

  • Execution: Read.

  • Permissions: Bookings permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

bookings.update

Reschedule a local reservation.

  • Tool: prepare_booking_update.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Bookings. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, notes, booking_type_id, events, booking_id.

Branding

branding.read

Read button branding.

  • Tool: get_branding_settings.

  • Execution: Read.

  • Permissions: Branding permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

branding.update

Update button branding.

  • Tool: prepare_branding_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Branding. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: button_color, button_radius.

Certificates and Papers

papers.create

Create a certificate.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Certificates and Papers. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

papers.issue

Issue certificates.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Certificates and Papers. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

papers.update

Edit a certificate.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Certificates and Papers. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Classes and events

classes.create

Create a class.

  • Tool: prepare_class_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Classes and events. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, price, maximum_attendance, occurrences.

  • Optional inputs: description, age_constraint.

classes.create_batch

Create a group of classes.

  • Tool: prepare_class_batch.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Classes and events. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, classes.

classes.list

List classes.

  • Tool: list_classes.

  • Execution: Read.

  • Permissions: Class management. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, id, ids, tag, tags, tag_mode, gl_id, from, to, sort_by, sort_dir, resolve_only, limit_candidates, limit.

classes.read

Read class details.

  • Tool: get_class_details.

  • Execution: Read.

  • Permissions: Classes and events permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: class_id.

classes.update

Edit existing class.

  • Tool: prepare_class_update.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Classes and events. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, changes, occurrences.

Clients

clients.create

Create a client profile.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Clients. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

clients.family

Manage family relationships.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Clients. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

clients.import

Import clients.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Clients. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

clients.merge

Merge duplicate clients.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Client access and merge permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

clients.update

Edit a client profile.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Clients. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Communications

communications.audience

Read audience counts.

  • Tool: get_communication_audience.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: recipient_list_id.

communications.delivery

Read delivery status.

  • Tool: get_communication_delivery.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: send_out_id.

communications.newsletter_create

Create newsletter draft.

  • Tool: prepare_newsletter_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: editorial_plan, name, subject, preheader, locale, blocks.

  • Optional inputs: catalogue_key, body, image_query, image_alt.

communications.newsletter_edit

Edit newsletter text and images.

  • Tool: prepare_newsletter_content_edit.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: template_id, edits.

communications.newsletter_read

Read newsletter content.

  • Tool: get_newsletter_content.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: template_id.

communications.newsletters

Find newsletters.

  • Tool: find_newsletter_drafts.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

communications.reschedule

Reschedule a communication.

  • Tool: prepare_communication_reschedule.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: send_out_id, scheduled_at.

communications.schedule

Schedule a communication.

  • Tool: prepare_communication_schedule.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: recipient_list_id, type, subject, body, template_id, comtype, scheduled_at.

communications.send

Send a communication.

  • Tool: prepare_communication_send.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: recipient_list_id, type, subject, body, template_id, comtype, scheduled_at.

communications.sms

Save an SMS draft.

  • Tool: prepare_communication_sms.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Communications. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: recipient_list_id, type, subject, body, template_id, comtype, scheduled_at.

communications.template_sample

Read newsletter design slots.

  • Tool: get_template_sample.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: catalogue_key.

communications.template_samples

Find newsletter designs.

  • Tool: list_template_samples.

  • Execution: Read.

  • Permissions: Communications permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: locale.

  • Optional inputs: query.

Configuration

configuration.tax_defaults

Set default taxes.

  • Tool: prepare_default_taxes.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Configuration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: tax_ids.

configuration.tax_save

Create or edit tax.

  • Tool: prepare_tax_settings.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Configuration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: tax_id, name, description, percentage, inclusive.

configuration.taxes

Read organization taxes.

  • Tool: list_organization_taxes.

  • Execution: Read.

  • Permissions: Configuration permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

Contact lists

lists.import

Import new list contacts.

  • Tool: prepare_list_import.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Contact lists. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: list_id, rows.

lists.recipients

Manage list recipients.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Contact lists. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

lists.save

Create or edit contact list.

  • Tool: prepare_contact_list.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Contact lists. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: list_id, name, description.

lists.search

Find saved contact lists.

  • Tool: find_contact_lists.

  • Execution: Read.

  • Permissions: Contact lists permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

lists.segment

Configure a contact segment.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Contact lists. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

subscriptions.manage

Manage subscription preferences.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Contact lists. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Conversations and attachments

website.attachment_use

Use an attached file for its confirmed purpose.

  • Tool: use_conversation_file.

  • Execution: Conversation or workspace operation.

  • Permissions: Conversations and attachments permissions. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: purpose.

  • Optional inputs: token, media_id.

website.conversation_files

Read files attached to this conversation.

  • Tool: get_conversation_files.

  • Execution: Read.

  • Permissions: Conversations and attachments permissions. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: none.

website.conversation_images

Read conversation images.

  • Tool: get_conversation_images.

  • Execution: Read.

  • Permissions: Conversations and attachments permissions. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: none.

website.image_selection

Let admin choose website images.

  • Tool: request_image_selection.

  • Execution: Conversation or workspace operation.

  • Permissions: Conversations and attachments permissions. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: none.

  • Optional inputs: count, collection.

Forms

forms.branching_read

Read form branching.

  • Tool: get_form_branching_context.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: form_id.

forms.commerce_auction

Add Auction item.

  • Tool: prepare_commerce_auction.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_checkbox_invoice_items

Add Checkbox invoice items.

  • Tool: prepare_commerce_checkbox_invoice_items.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_context

Commerce block references.

  • Tool: get_commerce_block_context.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

forms.commerce_donation

Add Donation.

  • Tool: prepare_commerce_donation.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_dynamic_price

Add Dynamic price.

  • Tool: prepare_commerce_dynamic_price.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_event_block

Add Class.

  • Tool: prepare_commerce_event_block.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_events_block

Add Multiple classes.

  • Tool: prepare_commerce_events_block.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_formula

Add Formula.

  • Tool: prepare_commerce_formula.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_fundraising

Add Fundraising.

  • Tool: prepare_commerce_fundraising.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_gift_card

Add Gift card.

  • Tool: prepare_commerce_gift_card.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_invoice_contribution

Add Invoice contribution.

  • Tool: prepare_commerce_invoice_contribution.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_invoice_items

Add Invoice items.

  • Tool: prepare_commerce_invoice_items.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_radio_invoice_items

Add Radio invoice items.

  • Tool: prepare_commerce_radio_invoice_items.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_resource_block

Add Resource.

  • Tool: prepare_commerce_resource_block.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_ticket_block

Add Event with tickets.

  • Tool: prepare_commerce_ticket_block.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.commerce_variable_price

Add Variable invoice item.

  • Tool: prepare_commerce_variable_price.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, options.

forms.conditions

Edit form branching.

  • Tool: prepare_form_conditions.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, question_id, branches.

forms.content_edit

Edit form text and images.

  • Tool: prepare_form_content_edit.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, edits.

forms.content_read

Read form content.

  • Tool: get_form_content.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: form_id.

forms.guide

Read the form building guide.

  • Tool: get_form_building_guide.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: industry, purpose.

forms.prepare

Prepare a form draft.

  • Tool: create_form_draft.

  • Execution: Create a draft; native review applies.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, industry, purpose.

  • Optional inputs: description, form_type, locale, apply_industry_defaults, questions.

forms.question_types

Add advanced form questions.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

forms.questions_edit

Edit form questions and order.

  • Tool: prepare_form_questions_edit.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, add, update, order.

forms.registration_rules

Configure advanced registration rules.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

forms.search

Find existing forms.

  • Tool: find_content_forms.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

forms.structure_read

Read form questions.

  • Tool: get_form_structure.

  • Execution: Read.

  • Permissions: Forms permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: form_id.

forms.translations

Translate form questions.

  • Tool: prepare_form_translations.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, locale, entries.

forms.waivers

Add approved waiver wording.

  • Tool: prepare_form_waivers.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, label, approved_text, signature.

memberships.sell_on_form

Sell a membership on a form.

  • Tool: prepare_membership_form.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, membership_id, show_participant, participant_date_of_birth.

products.form

Sell products on a form.

  • Tool: prepare_products_form.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Forms. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_id, form_name, locale, label, required, product_ids.

Help and product guidance

help.capabilities

Search product capabilities.

  • Tool: search_product_capabilities.

  • Execution: Read.

  • Permissions: Help and product guidance permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: query.

help.search

Search public Help articles.

  • Tool: search_help_articles.

  • Execution: Read.

  • Permissions: Help and product guidance permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: query.

help.task_guide

Read a task guide.

  • Tool: get_application_guide.

  • Execution: Read.

  • Permissions: Help and product guidance permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: area.

Integrations

integrations.configure

Configure an existing integration.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Integrations. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

integrations.inspect

Read integration configuration status.

  • Tool: get_integration_status.

  • Execution: Read.

  • Permissions: Integrations permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: service.

Invoices

invoices.add_items

Add items to existing invoice.

  • Tool: prepare_invoice_items.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Invoices. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: invoice_id, items.

invoices.adjustment_read

Read invoice adjustment context.

  • Tool: get_invoice_adjustment_context.

  • Execution: Read.

  • Permissions: Invoices permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: invoice_id.

invoices.cancel

Cancel standalone invoice items.

  • Tool: prepare_invoice_cancel.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Invoice cancellation permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: invoice_id, reason, items.

invoices.catalogue

Find invoice memberships, classes and booking resources.

  • Tool: get_invoice_catalogue.

  • Execution: Read.

  • Permissions: Invoices permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: kind.

  • Optional inputs: query, id.

invoices.context

Find invoice clients and taxes.

  • Tool: get_invoice_context.

  • Execution: Read.

  • Permissions: Invoices permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

invoices.create

Create client invoice.

  • Tool: prepare_invoice_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Invoices. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: client_id, locale, items.

invoices.credit

Credit invoice items.

  • Tool: prepare_invoice_credit.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Invoice credit/edit permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: invoice_id, reason, items.

invoices.edit_items

Edit invoice items.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Invoice credit/edit permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

invoices.list

Read client invoices.

  • Tool: list_client_invoices.

  • Execution: Read.

  • Permissions: Invoices permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: client_id, invoice_id, invoice_no.

Launching projects

recipes.launch

Launch a recipe project.

  • Tool: prepare_recipe_launch.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Launching projects. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: source_draft_thread_id.

Media library

media.delete

Delete library media.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Media library. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

media.import

Add media to the library.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Media library. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

media.organize

Edit image name and description.

  • Tool: prepare_media_metadata.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Media library. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: media_id, changes.

media.search

Find owned images.

  • Tool: find_owned_images.

  • Execution: Read.

  • Permissions: Media library permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

Memberships

memberships.create

Create membership.

  • Tool: prepare_membership_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Memberships. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, price, duration_type, duration, active_at, expired_at, tax_ids.

  • Optional inputs: description, subtype.

memberships.eligibility

Configure membership eligibility.

  • Tool: prepare_membership_eligibility.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Memberships. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: membership_id, action, by_tag, rules.

memberships.read

Read membership settings.

  • Tool: get_membership_details.

  • Execution: Read.

  • Permissions: Memberships permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: membership_id.

memberships.recurring

Configure recurring membership billing.

  • Tool: prepare_membership_recurring.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Memberships. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: membership_id, changes.

memberships.renewals

Configure membership renewal.

  • Tool: prepare_membership_renewals.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Memberships. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: membership_id, changes.

memberships.update

Edit membership.

  • Tool: prepare_membership_update.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Memberships. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: membership_id, changes.

Microsite

microsite.configure

Configure the microsite.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Microsite. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

products.microsite

Sell products on the microsite.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Microsite. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Organization

organization.modules

Read organization modules.

  • Tool: get_organization_modules.

  • Execution: Read.

  • Permissions: Organization administration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: area, include_inactive.

organization.users

List organization users.

  • Tool: list_admin_users.

  • Execution: Read.

  • Permissions: User management. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

organization.website_read

Read your organization’s website.

  • Tool: read_organization_website.

  • Execution: Read.

  • Permissions: Organization permissions. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: none.

  • Optional inputs: url.

Payments

payments.collect

Collect an invoice payment.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Payments. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

payments.deposit

Configure a deposit.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Payments. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

payments.installments

Configure payment installments.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Payments. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

payments.online_checkout

Configure online checkout.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Payments. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

payments.refund

Refund a payment.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Refund permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Point of sale

pos.configure

Configure a point of sale.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Point of sale. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

pos.sale

Prepare a point-of-sale transaction.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Point of sale. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Products

products.create

Create a product.

  • Tool: prepare_product_create.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Products. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, description, price, quantity, tax_ids, variants.

  • Optional inputs: image.

products.inventory

Adjust product stock.

  • Tool: prepare_product_inventory.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Products. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: product_id, variant_id, quantity, reason.

products.read

Read saved product details.

  • Tool: get_product_details.

  • Execution: Read.

  • Permissions: Products permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: product_id.

products.update

Edit a product.

  • Tool: prepare_product_update.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Products. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: product_id, changes.

products.variants

Edit product variants.

  • Tool: prepare_product_variants.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Products. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: product_id, variants.

Project recipes

recipes.inspect

Check project readiness.

  • Tool: get_recipe_project.

  • Execution: Read.

  • Permissions: Project recipes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: source_draft_thread_id.

recipes.list

Browse recipes.

  • Tool: list_application_recipes.

  • Execution: Read.

  • Permissions: Project recipes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

recipes.projects

Find recipe projects.

  • Tool: list_recipe_projects.

  • Execution: Read.

  • Permissions: Project recipes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

recipes.read

Read a recipe blueprint.

  • Tool: get_application_recipe.

  • Execution: Read.

  • Permissions: Project recipes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: recipe_id.

recipes.setup

Set up a recipe project.

  • Tool: prepare_recipe_setup.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Project recipes. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: recipe_id, name, locale, registrations, party, single_form, payment, content.

  • Optional inputs: is_closed.

Promo codes

promo_codes.create

Create promo code.

  • Tool: prepare_promo_code.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Promo codes. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, code, type, value, expires_on, max_usage, allow_multiple_use_per_client, any_class, any_membership, any_package, any_product, am_class_ids, membership_ids, package_ids, product_ids.

promo_codes.search

Find promo codes.

  • Tool: find_promo_codes.

  • Execution: Read.

  • Permissions: Promo codes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

promo_codes.targets

Find eligible promo-code resources.

  • Tool: find_promo_code_targets.

  • Execution: Read.

  • Permissions: Promo codes permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: kind.

  • Optional inputs: query.

Promotions and discounts

client_discounts.manage

Manage client discounts and subsidies.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Promotions and discounts. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

coupons.manage

Manage coupons.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Coupon/credit permission. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

gift_cards.create

Create a gift card.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Gift-card access. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

gift_cards.recharge

Recharge a gift card.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Gift-card access. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

gift_cards.update

Edit a gift card.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Gift-card access. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

loyalty.configure

Configure loyalty rewards.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Promotions and discounts. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

Registration

registration.cancel

Cancel future class registration.

  • Tool: prepare_class_cancellation.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, recipient_id.

registration.inspect

Inspect class registration and reminders.

  • Tool: get_registration_context.

  • Execution: Read.

  • Permissions: Registration permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: class_id.

registration.participants

Find class participants.

  • Tool: find_class_participants.

  • Execution: Read.

  • Permissions: Registration permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: class_id.

  • Optional inputs: query.

registration.readiness

Check registration readiness.

  • Tool: get_registration_readiness.

  • Execution: Read.

  • Permissions: Registration permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: class_id, form_id.

registration.settings

Open registration and configure confirmations.

  • Tool: prepare_registration_settings.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, form_id, is_closed, visible, confirmation, reminder_ids, reminders_enabled.

registration.setup

Set up class registration and reminders.

  • Tool: prepare_registration_workflow.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, class, form_id, form_name, locale, reminders.

  • Optional inputs: open_registration.

registration.shared_form

Create a shared class registration form.

  • Tool: prepare_shared_registration_form.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: form_name, locale, class_ids, question_label, introduction, is_closed.

registration.transfer

Transfer free class registration.

  • Tool: prepare_class_transfer.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, recipient_id, target_class_id, event_ids.

registration.waitlist

Find class waitlist.

  • Tool: find_class_waitlist.

  • Execution: Read.

  • Permissions: Registration permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: class_id.

  • Optional inputs: query.

registration.waitlist_remove

Remove waitlist entry.

  • Tool: prepare_waitlist_removal.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Registration. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: class_id, recipient_id.

Reports and charts

reports.active_memberships_report

Active memberships report.

  • Tool: run_active_memberships_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: date, from, to, membership_ids, include_not_yet_active, include_revenue.

reports.attendance_report

Attendance report.

  • Tool: run_attendance_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: am_class_ids.

reports.chart

Render a chart.

  • Tool: render_svg_chart.

  • Execution: Create a chart in the conversation.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: chart_type, series.

  • Optional inputs: title, subtitle, categories, width, height, auto_height, value_format, transpose, axis_mode, dataset_axis, y_axis_left_format, y_axis_right_format, y_axis_left_label, y_axis_right_label.

reports.classes_revenue_compare_report

Compare class revenue.

  • Tool: run_classes_revenue_compare_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: admin_id, am_class_ids, class_tags, class_tag_mode, classes_revenue_registered_before, compare_admin_id, compare_am_class_ids, compare_class_tags, compare_class_tag_mode, compare_classes_revenue_registered_before.

reports.classes_revenue_report

Class revenue report.

  • Tool: run_classes_revenue_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: admin_id, am_class_ids, class_tags, class_tag_mode, classes_revenue_registered_before.

reports.context

Financial report context.

  • Tool: get_financial_report_context.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: report_key.

  • Optional inputs: saved_report_id, configuration.

reports.discounts_report

Discounts report.

  • Tool: run_discounts_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: types, promo_code_ids.

reports.payments_by_gls_report

Payments by ledger code report.

  • Tool: run_payments_by_gls_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, point_of_sale_id, gl_id, is_scheduled, is_failed, is_contract, anchor_8pm.

reports.payments_report

Payments report.

  • Tool: run_payments_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, point_of_sale_id, gl_id, is_scheduled, is_failed, without_ledger_code, is_contract, anchor_8pm, payment_type.

reports.payments_summary_report

Payment summary report.

  • Tool: run_payments_summary_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, point_of_sale_id, gl_id, is_scheduled, is_failed, without_ledger_code, is_contract, anchor_8pm, payment_type.

reports.sales_by_gls_report

Sales by ledger code report.

  • Tool: run_sales_by_gls_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, type, gl_id, package_id, package_ids, product_id, membership_id, membership_ids, promo_code_id, product_tag, class_tag, membership_tag, is_am_class_addon, with_class, with_product, with_package, with_promo_code, point_of_sale_id, is_contract, anchor_8pm.

reports.sales_report

Sales report.

  • Tool: run_sales_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, type, gl_id, package_id, package_ids, product_id, membership_id, membership_ids, promo_code_id, product_tag, class_tag, membership_tag, is_am_class_addon, with_class, with_product, with_package, with_promo_code, with_membership, is_donation, point_of_sale_id, is_contract, without_ledger_code, anchor_8pm.

reports.sales_summary_report

Sales summary report.

  • Tool: run_sales_summary_report.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: from, to.

  • Optional inputs: admin_id, type, gl_id, package_id, package_ids, product_id, membership_id, membership_ids, promo_code_id, product_tag, class_tag, membership_tag, is_am_class_addon, with_class, with_product, with_package, with_promo_code, with_membership, is_donation, point_of_sale_id, is_contract, without_ledger_code, anchor_8pm.

Resources and availability

resources.get_resource_availability

Read resource availability.

  • Tool: get_resource_availability.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: resource_ids, from, to.

  • Optional inputs: step, limit.

resources.get_resource_events

Read resource events.

  • Tool: get_resource_events.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: resource_ids, from, to.

  • Optional inputs: limit.

resources.list_resources

List resources.

  • Tool: list_resources.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, name, type, tag, tags, tag_mode, root_location_id, sort_by, sort_desc, limit.

resources.show_resources_hierarchy

Read the resource hierarchy.

  • Tool: show_resources_hierarchy.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: root_location_id, root_location_ids, query, name.

Shared lookups

catalogue.list_booking_types

List booking types.

  • Tool: list_booking_types.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: ids, name.

catalogue.list_gls

List general ledger codes.

  • Tool: list_gls.

  • Execution: Read.

  • Permissions: Tax/ledger configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: id, name, type, posting_basis, sort_by, sort_dir, limit.

catalogue.list_invoices

List invoices.

  • Tool: list_invoices.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: page, sort_by, sort_dir, invoice_nos, invoice_no, gl_ids, gl_id, with_class, class_tags, class_tag, class_tag_mode, with_product, product_tags, product_tag, product_tag_mode, with_membership, membership_tags, membership_tag, membership_tag_mode, with_booking, with_package, package_ids, package_id, promo_code_ids, promo_code_id, promo_codes, promo_code, item_name, balance_min, balance_max, expected_balance_min, expected_balance_max.

catalogue.list_memberships

List memberships.

  • Tool: list_memberships.

  • Execution: Read.

  • Permissions: Membership management. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, id, ids, subtype, external, tag, tags, tag_mode, gl_id, resolve_only, limit_candidates, limit.

catalogue.list_packages

List packages.

  • Tool: list_packages.

  • Execution: Read.

  • Permissions: Booking configuration. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, id, ids, name, package_category, gl_id, resolve_only, limit_candidates, limit.

catalogue.list_products

List products.

  • Tool: list_products.

  • Execution: Read.

  • Permissions: Product management. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, name, id, ids, sku, gl_id, tag, tags, tag_mode, resolve_only, limit_candidates, include_images, limit.

catalogue.list_promo_codes

List promo codes.

  • Tool: list_promo_codes.

  • Execution: Read.

  • Permissions: Financial report access. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query, is_subsidy, is_active, resolve_only, limit_candidates, limit.

catalogue.list_tags

List tags.

  • Tool: list_tags.

  • Execution: Read.

  • Permissions: Tag management. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: type.

  • Optional inputs: query, only_upcoming, load_null.

Website

products.website

Sell products on the website.

  • Tool: request_application_task.

  • Execution: Native AM editor; native confirmations apply.

  • Permissions: Native editor access; Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: action_id, goal, task_kind.

website.components_manage

Manage all native website components.

  • Tool: prepare_website_component.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: page_id, expected_edit_version, action, section_id, after_id, type, template, content_json, settings_json, blocks.

website.components_read

Inspect website components.

  • Tool: get_website_component_context.

  • Execution: Read.

  • Permissions: Website permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: page_id, type, template.

  • Optional inputs: section_id.

website.create

Create website.

  • Tool: prepare_website_create.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: name, subdomain, locale.

website.design

Design a coherent website or page.

  • Tool: prepare_website_design.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: workspace_id, message.

  • Optional inputs: expected_workspace_revision, section_edits, text_patches.

website.navigation

Edit website navigation.

  • Tool: prepare_website_navigation.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: website_id, pages.

website.pages

List website pages.

  • Tool: list_website_pages.

  • Execution: Read.

  • Permissions: Website permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: none.

  • Optional inputs: query.

website.pages_manage

Create or edit website page.

  • Tool: prepare_website_pages_manage.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: website_id, page_id, changes.

Search Pexels website photos.

  • Tool: search_website_photos.

  • Execution: Read.

  • Permissions: Website permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: query.

  • Optional inputs: page, per_page, orientation.

website.publish

Publish or unpublish page.

  • Tool: prepare_website_publish.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: website_id, page_id, published.

website.read

Read website sections.

  • Tool: get_website_page.

  • Execution: Read.

  • Permissions: Website permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: page_id.

  • Optional inputs: section_ids.

website.sections_manage

Manage website sections.

  • Tool: prepare_website_sections_manage.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: page_id, expected_edit_version, message, operations.

website.settings

Edit website settings.

  • Tool: prepare_website_settings.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: website_id, changes.

website.structure_read

Read website structure.

  • Tool: get_website_structure.

  • Execution: Read.

  • Permissions: Website permissions. Assistant access is always required.

  • Credential: read-only or full catalogue.

  • Required inputs: website_id.

website.update

Edit website sections.

  • Tool: prepare_website_draft.

  • Execution: Prepare a change; human approval in AM.

  • Permissions: Website. Assistant access is always required.

  • Credential: full catalogue.

  • Required inputs: page_id, expected_edit_version, message, operations.

Workflow helpers

These tools support catalogue workflows rather than representing additional business actions. They require full-catalogue credentials; current module permissions still apply.

apply_assistant_draft

Request review of a prepared draft.

  • Execution: Request human review in AM.

  • Required inputs: draft_thread_id, am_session_id, am_run_id, am_call_id.

begin_mcp_turn

Begin the next message in an AM conversation.

  • Execution: Conversation or workspace operation.

  • Required inputs: am_session_id, message.

  • Optional inputs: image_ids, attachment_ids, file_tokens.

begin_website_design

Start a website design workspace.

  • Execution: Conversation or workspace operation.

  • Required inputs: page_id, expected_edit_version, scope, name, destination, am_session_id, am_run_id, am_call_id.

  • Optional inputs: text_query.

close_mcp_turn

Close an idle external turn.

  • Execution: Conversation or workspace operation.

  • Required inputs: am_session_id, am_run_id.

discover_application_actions

Discover permitted actions.

  • Execution: Read.

  • Required inputs: none.

  • Optional inputs: query, module, am_session_id, am_run_id, am_call_id.

get_application_action

Read an exact action contract.

  • Execution: Read.

  • Required inputs: action_id.

  • Optional inputs: am_session_id, am_run_id, am_call_id.

get_mcp_session

Read conversation progress and receipts.

  • Execution: Read.

  • Required inputs: am_session_id.

  • Optional inputs: since_thread_id.

get_website_design_tools

Inspect website design operations.

  • Execution: Read.

  • Required inputs: workspace_id, am_session_id, am_run_id, am_call_id.

  • Optional inputs: query.

operate_website_design

Edit the current website design workspace.

  • Execution: Conversation or workspace operation.

  • Required inputs: workspace_id, expected_workspace_revision, operations, am_session_id, am_run_id, am_call_id.

prepare_application_action

Prepare a registered action for review.

  • Execution: Conversation or workspace operation.

  • Required inputs: action_id, arguments, am_session_id, am_run_id, am_call_id.

read_assistant_knowledge_document

Read an organization knowledge document.

  • Execution: Read.

  • Required inputs: document_id, am_session_id, am_run_id, am_call_id.

  • Optional inputs: offset.

read_mcp_result

Read a stored tool result.

  • Execution: Read.

  • Required inputs: am_session_id, tool_result_id.

  • Optional inputs: offset.

search_assistant_knowledge

Search organization knowledge.

  • Execution: Read.

  • Required inputs: query, am_session_id, am_run_id, am_call_id.

select_website_design_photos

Select observed photos for a website design.

  • Execution: Conversation or workspace operation.

  • Required inputs: workspace_id, expected_workspace_revision, image_urls, am_session_id, am_run_id, am_call_id.

  • Optional inputs: section_ids, page_key, photo_queries.

start_mcp_session

Start an AM conversation and external turn.

  • Execution: Conversation or workspace operation.

  • Required inputs: message.

  • Optional inputs: name.