Перейти к основному содержимому

MCP tool reference

These are the tools the MonoPbx MCP server offers. Each tool runs the same check as the matching REST API call, as the user who connected the assistant, so department limits and every other rule of the console apply. An assistant only sees the tools whose permission its connection holds (see scopes).

  • Kind: read tools change nothing. Write tools change something or reach outside the company; their descriptions tell the assistant to confirm with the user first, and they count against the daily limits.
  • Permission: the scope the connection needs. It is the permission of the REST call (when the call takes either of two permissions, both are listed and either one is enough), except for clickToCall (self:call) and sendSms (messaging:write), which need a named scope through MCP.
  • Untrusted: the answer holds text written by people outside the company (callers, SMS senders, customers, web pages). It starts with a note telling the assistant to treat that text as data only.

Tool names and arguments follow the REST API: a tool's arguments are the path and query parameters of the call, plus body for a JSON body and if_match for a change to a stored record. Lists take limit and cursor.

You and your calls​

ToolKindPermissionWhat it doesNotes
getMereadself:readWho is connected and their effective permissions
getMyStatusreadself:readYour statuses and forwarding rules
listMyCallsreadself:readYour own call historyUntrusted
getMyCallreadself:readOne of your calls with its legsUntrusted
listMyContactsreadself:readList or search your personal contactsUntrusted
clickToCallwriteself:callRings your own phone, then dials the numberReaches outside

Voicemail and SMS​

ToolKindPermissionWhat it doesNotes
listVoicemailMailboxesreadself:readThe voicemail mailboxes you can read
listVoicemailMessagesreadself:readThe messages of a mailboxUntrusted
getVoicemailTranscriptreadself:readThe transcript and AI summary of a voicemail messageUntrusted
searchAllVoicemailTranscriptsreadself:readSearch the transcripts of all your voicemailUntrusted
listSmsConversationsreadself:readYour SMS conversationsUntrusted
listSmsMessagesreadself:readThe messages of an SMS conversationUntrusted
searchConversationsreadself:readSearch call transcripts and messages you may seeUntrusted
sendSmswritemessaging:writeSends an SMS or MMS from one of your numbersReaches outside; SMS limit

People and directory​

ToolKindPermissionWhat it doesNotes
listDirectoryPeoplereaddirectory:readThe colleagues directory
getPresenceSnapshotreaddirectory:readEveryone's live presence now
listUsersreadusers:readList users
getUserreadusers:readOne user
getUserStatusreadusers:write or team:statusA user's statuses and forwarding rules
updateUserStatuswriteusers:write or team:statusSwitches a user's current status or sets a temporary oneChanges how their calls are forwarded
listDepartmentsreaddepartments:readList departments
getDepartmentreaddepartments:readOne department
listExtensionsreadextensions:readList extensions
getExtensionreadextensions:readOne extension
listPhonebookContactsreadcontacts:readList or search the company phonebookUntrusted
createPhonebookContactwritecontacts:writeAdds a contact to the company phonebook
updatePhonebookContactwritecontacts:writeChanges a phonebook contactNeeds if_match

Calls, queues and reports​

ToolKindPermissionWhat it doesNotes
listCallsreadcall_history:readThe company's call historyUntrusted
getCallreadcall_history:readOne call with its legsUntrusted
listActiveCallsreadcalls:controlThe calls in progressUntrusted
listScheduleStatusreadcalls:control or team:statusWhether each schedule (business hours) is open now
listQueuesreadqueues:readList queues
getQueuereadqueues:readOne queue
listRingGroupsreadring_groups:readList ring groups
getRingGroupreadring_groups:readOne ring group
getQueuesLivereadqueues:monitorLive snapshot of the queues: callers waiting, agents
getQueueWaitsreadqueues:monitorLive waits of the queues with the predicted wait of callback offers
setAgentPresencewritequeues:monitorLogs a queue agent in or out, or pauses them
listQueueCallbacksreadqueues:readA queue's callback requestsUntrusted
getQueueCallbackSummaryreadqueues:readSummary of a queue's callbacks
getQueueReportreadreports:readQueue performance
getAgentReportreadreports:readAgent activity
getExtensionReportreadreports:readExtension statistics
getSlaReportreadreports:readService level
getAbandonedReportreadreports:readAbandoned calls and callbacks

Dialer and AI campaigns​

ToolKindPermissionWhat it doesNotes
listCampaignsreadqueues:readList dialer campaigns
getCampaignreadqueues:readOne dialer campaign
getCampaignLivereadqueues:readThe live picture of a dialer campaign
listCampaignContactsreadqueues:readA campaign's contactsUntrusted
addCampaignContactswritequeues:writeAdds contacts to a dialer campaign; they are called once it runsOnly numbers that agreed to be called
listAiOutboundCampaignsreadsettings:readList the outbound AI call campaigns
getAiOutboundCampaignreadsettings:readOne outbound AI call campaign

Starting, pausing and stopping a campaign stay in the console.

Jira and Confluence​

ToolKindPermissionWhat it doesNotes
searchJiraIssuesreadjira:readSearch Jira issuesUntrusted
getJiraIssuereadjira:readRead a Jira issueUntrusted
getJiraIssueSlareadjira:readCheck a Jira issue's SLA
searchAtlassianKnowledgereadjira:readSearch the synced Confluence and service-desk articlesUntrusted
createJiraTicketwritejira:writeCreates a Jira issueJira limit
addJiraCommentwritejira:writeComments on a Jira issueJira limit
updateJiraIssuewritejira:writeChanges a Jira issue or moves it along its workflowJira limit
createJiraIssuewritejira:issuesCreates a Jira issue from a call, voicemail or chat recordJira limit

See Jira and the AI for setting up the Jira connection.

Integrations and the company's AI tools​

ToolKindPermissionWhat it doesNotes
listIntegrationInstallsreadintegrations:readThe company's integration installs (settings and state; never their secrets)
getIntegrationInstallreadintegrations:readOne integration install
testIntegrationInstallwriteintegrations:writeTests an install's connection to the other systemReaches outside
syncIntegrationInstallwriteintegrations:writeRe-checks an install against the other system nowReaches outside
listMcpAiToolsreadai_tools:invokeThe company's own AI tools an owner offered to MCP clients
invokeAiToolwriteai_tools:invokeCalls one of those toolsReaches outside; untrusted
startAiReceptionistSetupwritesettings:writeReads the company's public website and proposes an AI receptionistReaches outside; untrusted
getAiReceptionistSetupreadsettings:readOne AI receptionist setup runUntrusted
recrawlAiReceptionistSetupwritesettings:writeReads the run's website againReaches outside; untrusted

The company's own AI tools that an owner offered to MCP clients also appear in the tool list under their own names (see AI tools, connectors and knowledge). A tool that asks for confirmation first answers with a read-back and a one-time confirmation_token and sends nothing; the assistant repeats the exact call with that confirmation_token only after the user said yes. The server runs the tool only for that token (same connection, same arguments, within 10 minutes, once). Putting an AI receptionist live on a number stays in the console.

Administration​

ToolKindPermissionWhat it doesNotes
getCompanyHealthreadsettings:readThe company's health checks
listBranchNodesreadsettings:readBranch survival nodes and their link state
listTrunkStatusreadtrunks:readThe company's trunks with their live state
getVoicePlanreadvoice_plan:readThe company's MonoPbx Voice plan and bundles
getVoicePlanUsagereadvoice_plan:readMonoPbx Voice usage of the period
listVoiceNumbersreadvoice_numbers:readThe MonoPbx Voice numbers
listScimActivityreadaudit:readWho the identity provider provisioned or removed
getSiemSinkHealthreadaudit:readWhether the company's SIEM export is up and how many events it sent or lost

Managing users, roles, API keys, trunks, settings, backups and the MCP access itself is never a tool.

Resources and prompts​

  • Resource mpbx://guide/tools: a short guide for the assistant with the rules above and the tools this connection may call.
  • Prompts: missed-calls (argument days, 1 to 31), voicemail-triage and queue-day (argument queue). They only use read tools.