Skip to content
verify mcp Beta VerifyMCP is currently in beta. If you notice any issues, email [email protected] and we’ll put it right.

FavCRM

REMOTE · API.FAVCRM.IO · SCANNED AUG 3

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

Available components

+8 this week 82 Trust /100
Trust breakdown (6 categories)

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. How we score →

Endpoint Security89
Transport & Reachability100
Schema Quality & AI Usability85
  • 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Pass
  • AI-judged instruction clarity (excellent).Pass
  • Tool/resource definitions use about 18916 tokens (~82/item across 228 items; 223 tools + 5 resources), lean.Pass
  • Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management27
  • Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage100
  • 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
  • 100% of tool parameters carry a description.Pass
  • Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Capabilities100
  • Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Install

Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.

remote · api.favcrm.io

# add to Claude Code
claude mcp add --transport http io-favcrm-favcrm https://api.favcrm.io/mcp
# ~/.codex/config.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
    }
  }
}
# add to OpenClaw
openclaw mcp add io-favcrm-favcrm --url https://api.favcrm.io/mcp --transport streamable-http
# ~/.hermes/config.yaml
mcp_servers:
  io-favcrm-favcrm:
    url: "https://api.favcrm.io/mcp"
// mcp.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 we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.

  • 3 Aug 26 +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.

  • 1 Aug 26 +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.

  • 31 Jul 26 +4
    • We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
  • 30 Jul 26 0
    • We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
  • 29 Jul 26 +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.

  • 28 Jul 26 +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.

  • 27 Jul 26 0
    • We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
  • 26 Jul 26 74

    First indexed and scored.

Diagnostics

Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.

Captured 3 Aug 2026 · Probed https://api.favcrm.io/mcp

TLS valid

Negotiated TLS 1.3 with TLS_AES_128_GCM_SHA256 .

Subject Issuer Valid from Valid until Key Signature Serial
CN=favcrm.io CN=WE1,O=Google Trust Services,C=US 13 Jun 2026 11 Sept 2026 ECDSA 256 ECDSA-SHA256 8b36e4b5d46a89d8137da5f9739177d7
SANs: favcrm.io, api.favcrm.io, *.api.favcrm.io
CN=WE1,O=Google Trust Services,C=US (CA) CN=GTS Root R4,O=Google Trust Services LLC,C=US 13 Dec 2023 20 Feb 2029 ECDSA 256 ECDSA-SHA384 7ff31977972c224a76155d13b6d685e3
CN=GTS Root R4,O=Google Trust Services LLC,C=US (CA) CN=GlobalSign Root CA,OU=Root CA,O=GlobalSign nv-sa,C=BE 15 Nov 2023 28 Jan 2028 ECDSA 384 SHA256-RSA 7fe530bf331343bedd821610493d8a1b
DNSSEC insecure

Validation of api.favcrm.io. Not signed

Zone DS Keys Algorithms Outcome
. trust_anchor 20326, 38696 8, 8 Verified
io. present 57355 8 Verified
favcrm.io. absent Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation
Authentication Challenged, unverified

The endpoint asked for a token, but we could not retrieve and validate the RFC 9728 metadata that tells a client how to obtain one.

Result Challenged, unverified
Enforced On tool calls
HTTP status 200
Header Value
strict-transport-security max-age=31536000
x-content-type-options nosniff
x-frame-options SAMEORIGIN
referrer-policy no-referrer

Protected resource metadata

Retrieved No
Problem no_resource_metadata
Transports 2 probes
Transport URL Outcome Status Location
streamable-http https://api.favcrm.io/mcp Verified 200
http (plaintext) http://api.favcrm.io/mcp HTTPS enforced 301 https://api.favcrm.io/mcp
MCP tools — 223 exposed · ~18,806 tokens

The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.

Tool Tokens
create_survey_invitation ~143

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

NameTypeReqDescription
accountIdstringCRM account ID to invite
channelstringIntended channel, e.g. email, sms, whatsapp, link
contactIdstringContact ID to invite
expiresAtstringOptional invitation expiry ISO datetime
metadataobjectOptional invitation metadata
recipientEmailstringRecipient email for link tracking
recipientNamestringRecipient display name for link tracking
recipientPhonestringRecipient phone for link tracking
surveyIdstringyesSurvey ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_tag ~45

Create a CRM tag for customer segmentation and organization.

NameTypeReqDescription
colorstringOptional display color, e.g. #2563eb
namestringyesTag name
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_task ~97

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

NameTypeReqDescription
accountIdstringLinked CRM account
assigneeIdstringcompany_members.id
descriptionstringDescription
dueDatestringISO date (YYYY-MM-DD)
prioritystringPriority
statusstringStatus filter
titlestringyesTask title
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_team_member_invite ~149

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.

NameTypeReqDescription
emailstringyesInvitee email address
expiresInHoursintegerInvite lifetime in hours. Defaults to 72, max 336.
modulesarrayOptional legacy module list to attach to the company member
namestringOptional display name for a new user
permissionsarrayOptional structured module permissions to attach to the company member
rolestringTeam member role to grant on acceptance
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_template ~200

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.

NameTypeReqDescription
categorystringyesUTILITY = transactional (order/shipping), MARKETING = promos, AUTHENTICATION = codes.
footerstringOptional small footer text.
headerTextstringOptional short bold header above the body.
languagestringLanguage code, default en_US.
messagestringyesBody text. Use {{1}}, {{2}} for personalised values.
namestringyesFriendly template name (a Meta-safe id is derived from it).
variableSamplesobjectExample values per variable number, e.g. {"1":"Sara"} — Meta reviews with these.
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_ticket ~125

Create a support ticket for a member issue.

NameTypeReqDescription
accountIdstringMember/account ID this ticket is about
categorystringTicket category
contactEmailstringContact email if no account ID
contactNamestringContact name if no account ID
contactPhonestringContact phone if no account ID
descriptionstringDetailed description of the issue
prioritystringTicket priority
sourcestringWhere the ticket originated
subjectstringyesTicket subject/title
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_variation ~132

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

NameTypeReqDescription
discountPricestringDiscounted price
memberPricestringMembers-only price
namestringVariation name
pricestringyesPrice as decimal string (e.g. "29.99")
productIdnumberyesThe product ID
selectedOptionsobjectOption selections e.g. {"Size": "Large"}
skustringVariation SKU
stockQuantitynumberStock quantity
stockStatusstringStock status
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

create_whatsapp_connect_link ~96

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.

NameTypeReqDescription
onboardingModestringUse cloud_api for a new WhatsApp Cloud API connection, or coexistence when connecting a WhatsApp Business App number.
ttlMinutesintegerConnect link lifetime in minutes. Defaults to 30.
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_account ~44

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

NameTypeReqDescription
accountIdstringyesThe account ID to soft-delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_campaign ~37

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

NameTypeReqDescription
campaignIdstringyesCampaign ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_category ~38

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

NameTypeReqDescription
categoryIdstringyesCategory ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_contact ~41

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

NameTypeReqDescription
contactIdstringyesThe contact ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_custom_field ~31

Delete a custom field definition and its stored values.

NameTypeReqDescription
definitionIdstringyesCustom field definition ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_deal ~32

Soft-delete a CRM deal from the sales pipeline.

NameTypeReqDescription
dealIdstringyesThe deal ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_invoice ~42

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

NameTypeReqDescription
invoiceIdstringyesInvoice ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_knowledge_document ~45

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

NameTypeReqDescription
documentIdstringyesKnowledge document ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_post ~37

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

NameTypeReqDescription
postIdstringyesThe post ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_post_type ~49

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

NameTypeReqDescription
postTypeIdstringyesPost type ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_post_type_field ~88

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).

NameTypeReqDescription
fieldIdstringyesField ID
forcebooleanDelete even if posts have data in this field. Existing meta values become orphaned.
postTypeIdstringyesPost type ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_promotion ~29

Delete a promotion. Past usage records are preserved.

NameTypeReqDescription
promotionIdstringyesPromotion ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_segment ~26

Delete a customer segment.

NameTypeReqDescription
segmentIdstringyesThe segment ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_service_package ~29

Delete a service package by ID.

NameTypeReqDescription
packageIdstringyesService package ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_tag ~33

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

NameTypeReqDescription
tagIdstringyesThe tag ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

delete_task ~27

Soft-delete a CRM task.

NameTypeReqDescription
taskIdstringyesThe task ID to delete
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

detach_tags ~50

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

NameTypeReqDescription
accountIdsarrayyesMember/account IDs to untag (max 100)
tagIdstringyesTag ID to detach
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

earn_loyalty_points ~104

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.

NameTypeReqDescription
accountIdstringyesThe member/account ID
amountintegeryesPositive integer amount to credit
fieldstringyesWhich loyalty unit to credit
reasonstringAudit-trail reason (e.g. "Booking completed", "Manual adjustment")
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

enrol_membership ~101

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.

NameTypeReqDescription
accountIdstringyesThe member/account ID to enrol
expiresAtstringOptional ISO date to override the tier-computed expiry.
tierIdstringThe membership tier ID. Omit to enrol on the default no-tier membership.
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

execute_tool ~76

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.

NameTypeReqDescription
argumentsobjectArguments object for the target tool. Must match the target input schema.
toolNamestringyesExact target tool name returned by search_tools
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

find_or_create_workroom_thread ~107

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.

NameTypeReqDescription
agentIdstringyesAI colleague ID for the Workroom DM
titlestringOptional title if a new thread is created
userIdstringMerchant user ID to notify. Defaults to the current MCP user when omitted.
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

generate_image ~191

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.

NameTypeReqDescription
aspectRatiostringOutput aspect ratio (e.g. 16:9, 1:1)
modelCodestringyesImage model code from list_image_models
negativePromptstringThings to exclude from generation
pollIntervalMsintegerDefault 3000.
pollTimeoutMsintegerDefault 60000.
promptstringyesGeneration prompt
seedintegerRandom seed for reproducible output
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

generate_post_cover ~217

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.

NameTypeReqDescription
aspectRatiostringAspect ratio passed to the model, e.g. "16:9", "1:1"
modelCodestringyesImage model code from list_image_models (e.g. nano-banana-2)
negativePromptstringThings to exclude from generation
pollIntervalMsintegerDefault 3000.
pollTimeoutMsintegerDefault 60000.
postIdstringyesThe post ID
promptstringyesImage generation prompt
seedintegerRandom seed for reproducible output
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_attachment_text ~99

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.

NameTypeReqDescription
attachmentIdstringyesThe attachment ID from the message attachments list
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_audit_log ~39

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

NameTypeReqDescription
auditLogIdstringyesAudit log ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_available_slots ~79

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

NameTypeReqDescription
datestringyesISO date to check (YYYY-MM-DD)
resourceIdstringOptional: filter by specific resource
serviceIdstringyesThe service to check availability for
staffIdstringOptional: filter by specific staff member
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_booking_detail ~34

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

NameTypeReqDescription
bookingIdstringyesThe booking ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_booking_settings ~29

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

Input schema present but exposes no named parameters.

NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_booking_stats ~26

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

Input schema present but exposes no named parameters.

NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_contact ~26

Fetch a single contact by ID.

NameTypeReqDescription
contactIdstringyesThe contact ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_conversation_messages ~63

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

NameTypeReqDescription
conversationIdstringyesThe conversation ID
limitnumberMax results (default 20)
searchstringSearch within messages
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_custom_field ~29

Get a custom field definition by ID.

NameTypeReqDescription
definitionIdstringyesCustom field definition ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_custom_field_values ~50

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

NameTypeReqDescription
entityIdstringyesEntity ID
entityTypestringyesEntity type
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_dashboard_stats ~40

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

Input schema present but exposes no named parameters.

NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_deal ~28

Get detailed CRM deal information by ID.

NameTypeReqDescription
dealIdstringyesThe deal ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_invoice ~33

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

NameTypeReqDescription
invoiceIdstringyesInvoice ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_invoice_stats ~29

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

Input schema present but exposes no named parameters.

NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_knowledge_document ~62

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.

NameTypeReqDescription
documentIdstringyesKnowledge document ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_loyalty_balance ~54

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

NameTypeReqDescription
accountIdstringyesThe member/account ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_member_profile ~31

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

NameTypeReqDescription
accountIdstringyesThe account ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_membership_tier ~30

Get a specific membership tier by ID.

NameTypeReqDescription
tierIdstringyesThe tier ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.

get_offer_rule ~31

Get offer rule detail including associated products and discounts.

NameTypeReqDescription
ruleIdstringyesThe offer rule ID
NameTypeReqDescription
datayesTool result payload — shape varies per tool, see the tool description
renderTypestringyesUI rendering hint for the result
summarystringyesOne-line human-readable summary of the action

No examples provided.