FavCRM
REMOTE · API.FAVCRM.IO · SCANNED AUG 3
Agentic CRM for service businesses — bookings, customers, WhatsApp, loyalty, invoicing.
Available components
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
- The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
- Authorisation is enforced on tool calls, but the challenge carries no valid RFC 9728 metadata, so a client cannot discover where to get a token. See how to fix → View diagnostics → Fail
- HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
- The HSTS (Strict-Transport-Security) header is present. View diagnostics → Pass
- DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail
Transport & Reachability100
- Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass
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
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
claude mcp add --transport http io-favcrm-favcrm https://api.favcrm.io/mcp
[mcp_servers.io-favcrm-favcrm] url = "https://api.favcrm.io/mcp"
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"io-favcrm-favcrm": {
"type": "remote",
"url": "https://api.favcrm.io/mcp",
"enabled": true
}
}
} openclaw mcp add io-favcrm-favcrm --url https://api.favcrm.io/mcp --transport streamable-http
mcp_servers:
io-favcrm-favcrm:
url: "https://api.favcrm.io/mcp" {
"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.
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.
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 |
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.
create_survey_invitation ~143
Create a token-auth survey invitation for a specific member/account or contact.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | CRM account ID to invite |
| channel | string | — | Intended channel, e.g. email, sms, whatsapp, link |
| contactId | string | — | Contact ID to invite |
| expiresAt | string | — | Optional invitation expiry ISO datetime |
| metadata | object | — | Optional invitation metadata |
| recipientEmail | string | — | Recipient email for link tracking |
| recipientName | string | — | Recipient display name for link tracking |
| recipientPhone | string | — | Recipient phone for link tracking |
| surveyId | string | yes | Survey ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
create_tag ~45
Create a CRM tag for customer segmentation and organization.
| Name | Type | Req | Description |
|---|---|---|---|
| color | string | — | Optional display color, e.g. #2563eb |
| name | string | yes | Tag name |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | Linked CRM account |
| assigneeId | string | — | company_members.id |
| description | string | — | Description |
| dueDate | string | — | ISO date (YYYY-MM-DD) |
| priority | string | — | Priority |
| status | string | — | Status filter |
| title | string | yes | Task title |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| string | yes | Invitee email address | |
| expiresInHours | integer | — | Invite lifetime in hours. Defaults to 72, max 336. |
| modules | array | — | Optional legacy module list to attach to the company member |
| name | string | — | Optional display name for a new user |
| permissions | array | — | Optional structured module permissions to attach to the company member |
| role | string | — | Team member role to grant on acceptance |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| category | string | yes | UTILITY = transactional (order/shipping), MARKETING = promos, AUTHENTICATION = codes. |
| footer | string | — | Optional small footer text. |
| headerText | string | — | Optional short bold header above the body. |
| language | string | — | Language code, default en_US. |
| message | string | yes | Body text. Use {{1}}, {{2}} for personalised values. |
| name | string | yes | Friendly template name (a Meta-safe id is derived from it). |
| variableSamples | object | — | Example values per variable number, e.g. {"1":"Sara"} — Meta reviews with these. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
create_ticket ~125
Create a support ticket for a member issue.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | Member/account ID this ticket is about |
| category | string | — | Ticket category |
| contactEmail | string | — | Contact email if no account ID |
| contactName | string | — | Contact name if no account ID |
| contactPhone | string | — | Contact phone if no account ID |
| description | string | — | Detailed description of the issue |
| priority | string | — | Ticket priority |
| source | string | — | Where the ticket originated |
| subject | string | yes | Ticket subject/title |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
create_variation ~132
Add a variation (size, color, etc.) to an existing product.
| Name | Type | Req | Description |
|---|---|---|---|
| discountPrice | string | — | Discounted price |
| memberPrice | string | — | Members-only price |
| name | string | — | Variation name |
| price | string | yes | Price as decimal string (e.g. "29.99") |
| productId | number | yes | The product ID |
| selectedOptions | object | — | Option selections e.g. {"Size": "Large"} |
| sku | string | — | Variation SKU |
| stockQuantity | number | — | Stock quantity |
| stockStatus | string | — | Stock status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| onboardingMode | string | — | Use cloud_api for a new WhatsApp Cloud API connection, or coexistence when connecting a WhatsApp Business App number. |
| ttlMinutes | integer | — | Connect link lifetime in minutes. Defaults to 30. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | yes | The account ID to soft-delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| campaignId | string | yes | Campaign ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| categoryId | string | yes | Category ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| contactId | string | yes | The contact ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_custom_field ~31
Delete a custom field definition and its stored values.
| Name | Type | Req | Description |
|---|---|---|---|
| definitionId | string | yes | Custom field definition ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_deal ~32
Soft-delete a CRM deal from the sales pipeline.
| Name | Type | Req | Description |
|---|---|---|---|
| dealId | string | yes | The deal ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| invoiceId | string | yes | Invoice ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| documentId | string | yes | Knowledge document ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| postId | string | yes | The post ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| postTypeId | string | yes | Post type ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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).
| Name | Type | Req | Description |
|---|---|---|---|
| fieldId | string | yes | Field ID |
| force | boolean | — | Delete even if posts have data in this field. Existing meta values become orphaned. |
| postTypeId | string | yes | Post type ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_promotion ~29
Delete a promotion. Past usage records are preserved.
| Name | Type | Req | Description |
|---|---|---|---|
| promotionId | string | yes | Promotion ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_segment ~26
Delete a customer segment.
| Name | Type | Req | Description |
|---|---|---|---|
| segmentId | string | yes | The segment ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_service_package ~29
Delete a service package by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| packageId | string | yes | Service package ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_tag ~33
Delete a CRM tag and remove it from all tagged entities.
| Name | Type | Req | Description |
|---|---|---|---|
| tagId | string | yes | The tag ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
delete_task ~27
Soft-delete a CRM task.
| Name | Type | Req | Description |
|---|---|---|---|
| taskId | string | yes | The task ID to delete |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
detach_tags ~50
Detach one tag from one or more member/account records.
| Name | Type | Req | Description |
|---|---|---|---|
| accountIds | array | yes | Member/account IDs to untag (max 100) |
| tagId | string | yes | Tag ID to detach |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | yes | The member/account ID |
| amount | integer | yes | Positive integer amount to credit |
| field | string | yes | Which loyalty unit to credit |
| reason | string | — | Audit-trail reason (e.g. "Booking completed", "Manual adjustment") |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | yes | The member/account ID to enrol |
| expiresAt | string | — | Optional ISO date to override the tier-computed expiry. |
| tierId | string | — | The membership tier ID. Omit to enrol on the default no-tier membership. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| arguments | object | — | Arguments object for the target tool. Must match the target input schema. |
| toolName | string | yes | Exact target tool name returned by search_tools |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| agentId | string | yes | AI colleague ID for the Workroom DM |
| title | string | — | Optional title if a new thread is created |
| userId | string | — | Merchant user ID to notify. Defaults to the current MCP user when omitted. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| aspectRatio | string | — | Output aspect ratio (e.g. 16:9, 1:1) |
| modelCode | string | yes | Image model code from list_image_models |
| negativePrompt | string | — | Things to exclude from generation |
| pollIntervalMs | integer | — | Default 3000. |
| pollTimeoutMs | integer | — | Default 60000. |
| prompt | string | yes | Generation prompt |
| seed | integer | — | Random seed for reproducible output |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| aspectRatio | string | — | Aspect ratio passed to the model, e.g. "16:9", "1:1" |
| modelCode | string | yes | Image model code from list_image_models (e.g. nano-banana-2) |
| negativePrompt | string | — | Things to exclude from generation |
| pollIntervalMs | integer | — | Default 3000. |
| pollTimeoutMs | integer | — | Default 60000. |
| postId | string | yes | The post ID |
| prompt | string | yes | Image generation prompt |
| seed | integer | — | Random seed for reproducible output |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| attachmentId | string | yes | The attachment ID from the message attachments list |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| auditLogId | string | yes | Audit log ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| date | string | yes | ISO date to check (YYYY-MM-DD) |
| resourceId | string | — | Optional: filter by specific resource |
| serviceId | string | yes | The service to check availability for |
| staffId | string | — | Optional: filter by specific staff member |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| bookingId | string | yes | The booking ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_contact ~26
Fetch a single contact by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| contactId | string | yes | The contact ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| conversationId | string | yes | The conversation ID |
| limit | number | — | Max results (default 20) |
| search | string | — | Search within messages |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_custom_field ~29
Get a custom field definition by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| definitionId | string | yes | Custom field definition ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| entityId | string | yes | Entity ID |
| entityType | string | yes | Entity type |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_deal ~28
Get detailed CRM deal information by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| dealId | string | yes | The deal ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| invoiceId | string | yes | Invoice ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| documentId | string | yes | Knowledge document ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-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.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | yes | The member/account ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_member_profile ~31
Get detailed profile for a specific member/account by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | yes | The account ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_membership_tier ~30
Get a specific membership tier by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| tierId | string | yes | The tier ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_offer_rule ~31
Get offer rule detail including associated products and discounts.
| Name | Type | Req | Description |
|---|---|---|---|
| ruleId | string | yes | The offer rule ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.