Skip to content
Docs
hi-client.com (opens in a new tab)

MCP tools

Download

Catalog of the hiClient MCP tools by area, with the permission each one requires and whether it reads, writes or deletes.

Tools are named area_verb (for example offers_list). An agent only sees the tools of the permissions you granted it: account_whoami reports the missing ones in agent.notGranted (see Conventions).

Types

Type Meaning
Read Changes nothing. Safe to repeat.
Write Changes something in the account. Recorded in the audit.
Destructive Deletes, withdraws, revokes or discards something, or cuts an access. Review it before approving.
Contacts third parties Sends an e-mail or brings content from outside the account.

Each tool declares its exact MCP annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint) in tools/list. Assistants usually ask for your approval before running the ones that are not read-only.

Account

Tool What it does Permission Type
account_whoami Account, business and your role in it, plan, granted permissions, what each area covers and what stays reserved to the portal. none Read

Offers

Tool What it does Permission Type
offers_list Lists offers (events and stays) with state and dates. 24 per page. offers:read Read
offers_get Reads one offer in full with its revision. offers:read Read
offers_summary Totals of offers, drafts, bookings and sales of the period. offers:read Read
offers_activity Activity of one offer or service: responses by state, occupancy, collected amount, page views, 30-day series and publication history. offers:read Read
offers_drafts_list Lists the private drafts of the editor. offers:read Read
offers_draft_get Reads a draft in the shape offers_save takes. offers:read Read
offers_save Creates an offer or replaces it in full. Reports every missing or invalid field at once. Accepts dryRun. offers:write Write
offers_set_published Publishes or withdraws an offer. Withdrawing stops the page and new bookings. offers:write Destructive
offers_duplicate Copies an offer unpublished, without bookings or payments. Returns fieldIds: id of each original field → id in the copy. offers:write Write
offers_reconnect Moves an offer from a revoked device to an active one. offers:write Write
offers_draft_save Saves a private draft without validating or publishing (up to 50). offers:write Write
offers_draft_delete Deletes a private draft at its revision and frees its place. Never touches offers or bookings. offers:write Destructive
services_list Lists recurring services (memberships, fees, classes) with price, frequency, places taken and state, plus the channels of the business's market. 24 per page. offers:read Read
services_get Reads one recurring service in full with its revision; termsLocked says it already has adhesions. offers:read Read
services_save Creates a recurring service or updates it (omitted values are kept), with the rules of the portal editor. Reports every invalid field at once. Accepts dryRun and returns the next periods. offers:write Write
services_set_published Publishes or withdraws a recurring service. Withdrawing stops the page and new adhesions; existing ones are kept. offers:write Destructive

Bookings and calendar

Tool What it does Permission Type
bookings_list Lists received bookings. Filter by instance with pluginId; 24 per page. bookings:read Read
bookings_get Reads one booking: dates, quantity, amounts, payment and attendance. bookings:read Read
calendar_month Month view: offers per day and confirmed and pending quantities. bookings:read Read

Forms and inbox

Tool What it does Permission Type
forms_list Site forms (Contact and Application modules), published and in the draft, with the revision that forms_save and the site_* tools take. published stays empty while the site is not published (sitePublished). forms:read Read
inbox_tags_list Inbox tags and arrival defaults. forms:read Read
forms_save Changes one form in the site draft; visitors see it after site_publish. Accepts dryRun. forms:write Write
plugin_forms_list Own forms (kind=form, Forms plugin) or job postings (kind=job, Jobs plugin) with state, revision, closing date, limit and how many answers arrived (total and new). No answer content. forms:read Read
plugin_form_get One form or job posting with its questions, settings and (posting) area, work mode, schedule, location, salary, requirements and benefits. forms:read Read
plugin_forms_answers_summary Number of answers of each form or applications of each posting, by state. No answers, people or files. forms:read Read
plugin_form_save Creates or changes a form or job posting (11 question kinds, confirmation message, limit, closing date, job facts). Applied at once; a new one starts as a draft. Accepts dryRun. forms:write Write
plugin_form_set_state Opens, closes, archives or returns to draft a form or job posting. Answers are kept. forms:write Write
registration_requirements_get Data the hiClient app asks from people who register with the business (personal data besides the name, record fields and face), with the revision and the change the PC has not applied yet. forms:read Read
registration_requirements_set Chooses that data; the PC that receives the requests applies the change when online. forms:write Write
inbox_change Marks a message read or unread, changes its state or note. Closing revokes the visitor's link. forms:write Destructive
inbox_set_tags Replaces the tags of a message. forms:write Write
inbox_tags_save Creates or renames a tag (up to 20). forms:write Write
inbox_tags_delete Deletes a tag. Messages are untouched. forms:write Destructive
inbox_defaults_set Chooses whether new messages arrive read and which tags they get. forms:write Write

Site: profile and publication

Tool What it does Permission Type
site_status Address, real state (draft, private, public), revision, pending changes, business layout and counts. site:read Read
site_get Reads the profile (draft or published): layout, identity, content, modules with their visibility and operational state, extra pages and questions. site:read Read
site_address_check Tells whether an address is valid, free or retired by this account (previous: true). site:read Read
site_create Creates the site with the structure of the business type, unpublished. Asks for the address and, when missing, the public name. site:write Write
site_content_set Tagline, introduction, highlights, cover and library photos. Anything omitted is kept. site:write Write
site_identity_set Visual style of the layout, accent color, monogram and logo. site:write Write
site_page_upsert Adds or changes an extra page: title, text and optional photo (up to 6). site:write Write
site_page_remove Removes an extra page from the pending changes. site:write Destructive
site_faq_set Replaces the list of frequently asked questions (up to 20). site:write Destructive
site_publish Publishes the pending changes. site:write Write
site_cancel_draft Discards the pending changes. site:write Destructive
site_unpublish Stops serving the published site. site:write Destructive
site_publication_set Visibility, countries, indexing and message for blocked visitors. site:write Write
site_private_link_renew Issues a new private link and invalidates the previous one. site:write Destructive
site_address_change Changes the address; the previous one redirects to the new one. site:write Write

The business name, description, address, hours and links are not part of the site: read them with profile_get and change them with profile_public_save. Offers, prices and availability come from the operation (offers_*, bookings_*).

Site: modules

Tool What it does Permission Type
site_module_set Enables or disables a module (enabled = shown on the public profile, at once) and changes its title and settings (forms, offers it lists, gallery). For plugins it also suspends or resumes registrations, sets the closing date and archives. Never deletes offers, bookings, payments, answers or messages. site:write Write

Modules: about, stays, events, catalog, calendar, services, gallery, posts, faq, location, contact, registration, pages. Each business type offers its own and names them its way, for example «Rooms» for stays in a hotel.

Hiding a module does not turn off its operation: offers stay published and bookable and messages keep arriving. A section shows when the module is visible and its source has content (shown); state and operateUrl say what is missing and where to fix it. Every site write takes a single revision: when it changed, the answer is conflict with currentRevision.

Site: files

Tool What it does Permission Type
site_media_list File library, recent jobs and storage usage. site:read Read
site_media_catalog Searches freely licensed (CC0) photos in the catalog. site:read Read
site_media_upload Uploads an image or a small document in base64. It is converted to one uniform format (WebP, MP4 or PDF) and the tool waits a few seconds for the result. site:write Write
site_media_import Copies a catalog photo into the library (WebP) and waits a few seconds for the result. site:write Contacts third parties
site_media_change Renames, moves to a folder (single level), protects or trashes a file. sanitized: true when it adjusted the name or folder. site:write Write

Messages and tickets

Tool What it does Permission Type
messages_list Received messages, newest first. Filter by instance with pluginId. messages:read Read
messages_get One message with answers, conversation and private notes. messages:read Read
tickets_list The account's support tickets. messages:read Read
tickets_get One ticket and a page of its messages. messages:read Read
tickets_create Opens a support ticket. messages:write Write
tickets_reply Replies to one of your tickets, unless support closed it to new messages. messages:write Write
tickets_set_status Closes or reopens one of your tickets. messages:write Write
messages_settings_get The business's automatic replies per channel (app chat, site message, form): welcome, away with hours and the chat's option menu. messages:read Read
messages_settings_set Replaces those automatic replies (only texts written by the business; links from a closed catalog). messages:write Write
contact_policy_get How customers contact the business from the app: who can message, call and video call (combinable groups: anyone, people who sent a request, accepted customers, people who bought, people with a deposit or reservation, people accepted to upcoming or ongoing events) and how requests are accepted, with a one-sentence summary. messages:read Read
contact_policy_set Replaces that policy (only as the business asked). messages:write Write
inbox_reply Replies to a visitor on your behalf: they get an e-mail with a private link. Listed only if you granted messages:reply. messages:reply Contacts third parties

State changes, notes and tags of messages are in Forms and inbox.

Publications

Tool What it does Permission Type
publications_list Public profile posts (with sizeBytes and mediaBytes), listings of your PCs and pending dispatches. publications:read Read
publications_publish Publishes or edits a post, or queues a dispatch to listings of a PC. Accepts dryRun. publications:write Write
publications_delete Deletes a post or removes an accepted dispatch from the history. publications:write Destructive
publications_enable Turns on the posts tab of the public profile. publications:write Write

Reports

Tool What it does Permission Type
reports_overview Dashboard counters. reports:read Read
reports_dashboard Figures behind the cards of the portal home. reports:read Read
reports_sales Sales aggregated by day, currency and state (up to 366 days). reports:read Read
reports_orders_list Online payment orders. 25 per page. reports:read Read
reports_orders_get One payment order. reports:read Read

Devices and alerts

Tool What it does Permission Type
devices_list Active devices and the plan maximum, with each device's location, role, local network and backups. devices:read Read
devices_topology Device map: local networks, links between devices and backups. devices:read Read
devices_pending_desktop What is waiting for the desktop app: counts per kind (bookings, tickets, registrations, requests…) and whether a PC is linked. devices:read Read
devices_access_feed Latest accesses: time, method, result and device. devices:read Read
devices_access_stats Daily count of accesses by result (up to 90 days). devices:read Read
alerts_recipients_list Alert recipients, with masked e-mail. devices:read Read
devices_rename Renames an active device. devices:write Write
devices_revoke Revokes a device. It needs a recent sign-in: it answers portal_only and is done in the portal. devices:write Destructive
devices_use_seat Chooses which device keeps a seat of the plan. It needs a recent sign-in: it answers portal_only and is done in the portal. devices:write Write
alerts_recipient_add Adds a recipient and e-mails it a verification code. devices:write Contacts third parties
alerts_recipient_verify Confirms a recipient with its 6-digit code. devices:write Write
alerts_recipient_remove Removes a pending recipient. devices:write Destructive
alerts_channel_set Resumes the alert e-mail channel. devices:write Write

Profile and settings

Tool What it does Permission Type
profile_get Account, organization, business date format, public profile, notifications and portal home. profile:read Read
profile_save Account and organization data, including the business date format. profile:write Write
profile_public_save Public profile and mobile app tabs. profile:write Write
settings_language_set Interface language (es, en, pt). profile:write Write
settings_appearance_set Theme dark or light. profile:write Write
settings_notifications_set Notification types and web and e-mail channels. profile:write Write
settings_toasts_set Pop-up notices: duration and optional kinds (confirmations, information, new notifications). profile:write Write
workspace_cards_set Visible cards of the portal home. profile:write Write
workspace_banner_set Banner of the home (mountains, sea, jungle, desert). profile:write Write
workspace_navigation_set Order and archived sections of the portal's left menu. profile:write Write

profile_get and profile_save return account.businessDateOrder, the business’s effective date order. In profile_save, businessDateOrder accepts dmy (day/month/year), mdy (month/day/year) or ymd (year/month/day). Omitting it keeps the choice; an empty string restores the default for the business’s country. This is independent of personal preferences.

What is not in the catalog

By design there are no tools for plans, payments, payment collection, domains, account security, export or deletion of the account. Some portal actions answer portal_only: see Overview.

Services and installments

Services and installments is a financial feature: there are no MCP scopes or tools to manage enrollments, amounts, discounts, charges or automatic debits. Site permissions only allow composing the catalog plugin; they do not authorize those operations.

site_media_list includes dimensions and available renditions (width, height, variantVersion, variants). Each rendition reports its longest side, dimensions and bytes. Thumbnails count toward storage; the detail file is retained.

Email (D175)

mail_preferences_get (profile:read) reads the account's own promotional consent; mail_preferences_unsubscribe (profile:write) revokes it idempotently through the profile service. mail_status (profile:read) reports the business's own provisioning, pause, quotas and domain verification. They never return recipient addresses, messages, credentials or unsubscribe links. Opt-in, general terms acceptance and domain changes remain in the portal; sending activation and reputation controls are administration-only. Platform and business transactional sending is active. Promotional sending remains disabled.

Email folders

mail:read allows mail_mailboxes_list, mail_messages_list and mail_message_get: own mailboxes, folders, search and paginated reading. Third-party addresses are masked; subjects, bodies and filenames are untrusted data.

mail:write allows mail_draft_save, mail_compose_from (reply, reply all or forward into a draft) and mail_message_change (read, star, archive, spam, trash, restore, delete, cancel a pending send and edit, which returns a blocked send to Drafts to fix and send again). Every change requires the current revision.

mail:send allows mail_draft_send: queues an owned draft. Provider acceptance does not prove inbox delivery. An uncertain result is never automatically resent.

These permissions are separate: messages:* continues to cover forms and tickets and does not grant email access. Create or disable mailboxes, accept terms, manage domains and upload or download attachments in the portal. The tools share the web mail service, isolation, quotas and pause controls.

Form responses

forms_responses_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

Returns only aggregate counts of retained and synchronized responses, filtered by source or plugin. It exposes no answers, names, exports, faces or payment operations.

Email is covered by the general hiClient terms and requires no additional acceptance. mail_status returns termsAccepted and termsAcceptanceUrl (/account/legal). When the edition changes, the account holder must accept it there; MCP cannot accept on their behalf. acceptableUseVersion remains historical evidence and does not authorize sending.

Own forms and jobs

plugin_forms_list, plugin_form_get, plugin_forms_answers_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

plugin_form_save · forms:write · readOnly=false, idempotent=false, destructive=false, openWorld=false. plugin_form_set_state · forms:write · readOnly=false, idempotent=true, destructive=false, openWorld=false.

Forms and Jobs plugins: the business creates Google Forms-like forms or job postings and opens them on its public profile and in the app. MCP manages only the definitions and sees counts: never answers, applicants, their contact data or their files (CV), which are seen in the portal and in the app. Enabling the plugin on the profile is site_module_set.