Pepper Cloud

Get who is calling — the authenticated user's own CRM user id, name and email. Call this first whenever a request refers to the caller ("me", "my", "assign to me") and use the returned id for the assignee field. Never guess who the caller is from get_crm_users.

get_current_user

Get current exchange rates for all supported currencies. Call before summing or averaging amounts across currencies.

get_exchange_rate

Fetch messaging channel integrations (e.g. WhatsApp, Xero, Telegram) configured for the account.

get_integrations

Get the fields, their types, and the record or activityType shape for any CRM module

get_module_schema

Get one or more Xero quotations' full details by id. Only call this to fetch current data before update_quotation — never for displaying quotation details, which the UI handles.

get_quotation_by_id

Get Xero form configuration (items, tax rates, branding themes, currencies) needed to build a quotation.

get_quotation_form

Run a MongoDB aggregation over quotations — use for any quotation list/count/search/analysis query. Returns real, complete results — {recordsTotal, limit, skip, quotations} — not a capped sample. Use page/pageSize/sorted to page through results when total exceeds what's already been returned. Call get_module_schema (moduleId: "QTM") first for field names, ObjectId rules, and pipeline-building guidance. Don't include $sort/$skip/$limit in the pipeline itself — use page/pageSize/sorted instead.

get_quotations_aggregate_paginated

Query a CRM module's records, or Activities (NOTE, TASK, LOG, EVENT) when activityType is given, with a MongoDB aggregation pipeline. Returns real, complete results — {total, limit, skip, records} — not a capped sample. Use page/pageSize/sorted to page through more when total exceeds what's already been returned. Build the pipeline from the field ids and types from get_module_schema. Always project raw database paths only (e.g. records.F2: 1, records.F3: 1).

get_records_paginated

Get valid assignee suggestions for a CRM module — call before assigning a record to find who can be assigned. If same name appears, take confirmation from user before assigning. Do not call this when asked to assign to "me" — use get_current_user instead

get_suggestion_params

Fetch comments, checklist, and/or timeline for a ticket.

get_ticket_info

Run a MongoDB aggregation over tickets — use for any ticket list/count/search/analysis query. Returns real, complete ticket documents — {total, limit, skip, records} — not a capped sample or id-only list. Use page/pageSize to page through results when total exceeds what's already been returned. Call get_module_schema (moduleId: "TM") first for field names, ObjectId rules, and pipeline-building guidance. Don't include $skip/$limit in the pipeline itself — use page/pageSize instead; $sort is fine to include in the pipeline.

get_tickets_aggregate_paginated

List Xero contacts available for linking to a CRM account.

get_xero_contacts

Create a new activity (mode='create', NOTE/TASK/LOG/EVENT) linked to one or more business records, or update fields on an existing one (mode='update'). For updates, include only the fields being changed, using exact fieldIds. Before creating, collect the required fieldsfrom the user — never invent, assume, or auto-fill values the user didn't provide. Use defaults unless the user explicitly overrides them.

save_activity

Create a new business record (mode='create') or update fields on an existing one (mode='update'). For updates, include only the fields being changed. Field value formats: - Text: String value directly - Number: Numeric value - Date/DateTime: ISO 8601 format - Currency: {"currencyType": "USD", "amount": 1000} - Phone: String with country code - Email: Valid email string - Reference fields (Account, Assigned to): Use the ID - Enum/Select: Use raw enum value (e.g. "OPEN", not display label) - Percent: string (e.g. "75")

save_business_record

Create a new support ticket (mode='create') or update fields on an existing one (mode='update'), including escalating it or closing it. Call get_module_schema (moduleId: "TM") first for valid pipeline/pipelineStage IDs and confirm details with the user before creating. For updates, records must contain ONLY the fields actually changing — omit anything unchanged, and never pass null for a field just to keep it as-is. Escalate with escalate=true, or close via records.status="CLOSED".

save_ticket

Search the Organization knowledge base such as Pdf, Docs, and other knowledge base articles.

search_knowledge_base

Create a new Xero contact for a CRM account, or link the account to an existing Xero contact.

sync_xero_contact_tool

Push/sync a CRM quotation with Xero.

sync_xero_quote_tool

Update an existing Xero quotation. Requires the full payload — call get_quotation_by_id first to get current field values, then send them all back with the changed fields updated. Returns only the quotation's id — displaying it is handled in the UI.

update_quotation

Check a MongoDB aggregation pipeline's structure before passing it to get_records, get_tickets_aggregate, get_quotations_aggregate, or get_conversations_aggregate. Catches malformed stages (e.g. multiple fields in one stage object, unknown or disallowed stage names) so errors surface before the call instead of as a MongoServerError. This is a structural check only — it does not verify field paths or operator arguments, and does not run the pipeline against real data.

validate_pipeline