Customer documents

The 8 MCP tools in Customer documents, granted with the documents scope under Product configuration.

To let an assistant use these tools, grant Product configuration on the consent screen, or just Customer documents under its Fine-tune. The scope is documents. Read tools work with Read only or Read & write access; write tools only with Read & write.

Your assistant doesn't see these tools straight away. It finds them with search_tools or describe_tools, and runs one with use_tool, passing its name and arguments. Most assistants do this for you: just ask for what you want.

What your assistant is told about this group

The documents customers receive: policy wording, the schedule and others. Documents made from a template (HTML with Liquid placeholders) can be edited here; edits are a draft that goes live with the next release. Uploaded PDFs are managed in the dashboard. Past versions never change: restore_document_version copies an old version into the draft.

The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.

list_documents

Read List product documents

List a product's customer documents (policy wording, schedule, etc.) with version and release state. Active first, archived after.

Arguments

FieldTypeDescription
product_id required string
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

get_document

Read Get a product document

Fetch one document with its full version history. include_content: true adds the editable HTML (working draft, else live) for templated documents.

Arguments

FieldTypeDescription
id required string Document id
include_content boolean
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

create_document

Write Create a templated document

Create a templated (HTML/Liquid) customer document with its first draft version. Omit html_content to start from the built-in template. It goes live with the next product release. Uploaded-PDF documents are managed via the dashboard, not MCP.

Arguments

FieldTypeDescription
product_id required string
kind required string One of: "policy_wording", "ipid", "welcome_letter", "claim_acknowledgement", "claim_settlement", "claim_decline", "policy_schedule", "terms_of_business", "privacy_notice", "summary_of_cover", "complaints_procedure", "cancellation_confirmation", "renewal_invitation", "endorsement_confirmation", "other"
name required string
journey_id string Scope the document to one journey (optional)
html_content string Liquid-templated HTML; must satisfy the kind's rules (the schedule needs {{content}} or {{cover_table}})
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

update_document_template

Write Update a document template

Save HTML into a templated document's working draft (created lazily from the live version). Goes live with the next product release.

Arguments

FieldTypeDescription
id required string Document id
html_content required string
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

discard_document_draft

Write Discard a document draft

Drop a document's unpublished draft; the live version keeps serving. A never-published document must be archived instead.

Arguments

FieldTypeDescription
id required string Document id
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

restore_document_version

Write Restore a document version

Copy an old version of a templated document into the current draft. Past versions never change.

Arguments

FieldTypeDescription
id required string Document id
version_number required integer
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

archive_document

Write Archive a document

Retire a document (policies already issued keep the copies they were sent). Refused while a lifecycle event still attaches it.

Arguments

FieldTypeDescription
id required string Document id
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

move_document

Write Reorder a document

Move a document to a new position (0-based) among the product's active documents: the order every customer surface shows.

Arguments

FieldTypeDescription
id required string Document id
position required integer Target position, 0-based
org string Organisation slug: required when this authorization covers more than one organisation (see list_orgs)

Stuck, or something missing?

Get in touch and a person on the team will help.

Contact us