Skip to content

Latest commit

 

History

History
276 lines (270 loc) · 19.4 KB

mcp-coverage.md

File metadata and controls

276 lines (270 loc) · 19.4 KB

Hosted MCP coverage

Generated by bun run mcp:coverage. In Code Mode each operation below is its own typed tool. The second column gives its equivalent resource tool and action in plain MCP. Both catalogs also offer the inbox long poll: waitForMessage or messages with action wait.

Connect to /mcp for resource tools. /mcp?codemode=false lists each operation as its own tool, for clients that search or script tools themselves: OpenCode adds it to a remote URL, and Claude Code and Codex can use the same URL (?codemode=true and ?toolsets=all are older names for it). Filter listings in either mode with toolsets= (inboxes, routing, rituals, endpoints, sending, admin). Toolsets change what is listed, never what a grant may call.

Each tool call acts in one workspace: pass workspace (an ID or name), or the connection's default is used. The workspaces tool lists the person's workspaces, their role and the connection's access in each; setDefaultWorkspace (in plain MCP, workspaces with action setDefault) sets the default.

Plain listings summarize required and common fields. Use describe_tool({resource, action}) for the full input and output schemas of a listed action, or pass known arguments directly.

The remaining rows are human steps: OAuth consent, a forward recipient's confirmation link, browser redirects and account administration. Tools that start one return its status and the next step.

Code Mode operation Plain tool · action · toolset, or why it is a human step
listMcpConnections connections · list · admin
bindMcpConnection connections · bind · admin
revokeMcpConnection connections · revoke · admin
listAgents connections · agents · admin
revokeAgent connections · revokeAgent · admin
getCurrentIdentity settings · identity · admin
createAgentToken keys · createToken · admin
listAgentTokens keys · listTokens · admin
revokeAgentToken keys · revokeToken · admin
createApiKey keys · create · admin
listApiKeys keys · list · admin
revokeApiKey keys · revoke · admin
listContacts contacts · list · sending
createContact contacts · create · sending
getContact contacts · get · sending
updateContact contacts · update · sending
deleteContact contacts · delete · sending
updateContactConsent contacts · consent · sending
listContactConsentEvents contacts · consentEvents · sending
listContactLists lists · list · sending
createContactList lists · create · sending
getContactList lists · get · sending
updateContactList lists · update · sending
deleteContactList lists · delete · sending
listListMembers lists · members · sending
addListMembers lists · addMembers · sending
removeListMember lists · removeMember · sending
listSegments segments · list · sending
createSegment segments · create · sending
getSegment segments · get · sending
updateSegment segments · update · sending
deleteSegment segments · delete · sending
previewSegment segments · preview · sending
previewContactImport imports · preview · sending
listContactImports imports · list · sending
getContactImport imports · get · sending
commitContactImport imports · commit · sending
queryAudience audience · query · sending
planAudienceMutation audience · plan · sending
applyAudiencePlan audience · apply · sending
listCampaignTemplates templates · list · sending
createCampaignTemplate templates · create · sending
getCampaignTemplate templates · get · sending
updateCampaignTemplate templates · update · sending
deleteCampaignTemplate templates · delete · sending
publishCampaignTemplate templates · publish · sending
previewCampaignTemplate templates · preview · sending
renderCampaignTemplatePreviewImage templates · previewImage · sending
setCampaignTemplateArchived templates · archive · sending
uploadTemplateAsset assets · upload · sending
importTemplateImage assets · importImage · sending
getTemplateAsset assets · get · sending
deleteTemplateAsset assets · delete · sending
getTemplateAssetContent assets · content · sending
checkEmail send · check · sending
sendEmail send · single · sending
sendEmailBatch send · batch · sending
previewEmail send · preview · sending
listEmails logs · list · sending
getEmail logs · get · sending
getEmailDetail logs · detail · sending
getEmailContent logs · content · sending
listEmailEvents logs · events · sending
uploadAttachment attachments · upload · admin
getAttachment attachments · get · admin
deleteAttachment attachments · delete · admin
getAttachmentContent attachments · content · admin
createCampaign campaigns · create · sending
listCampaigns campaigns · list · sending
getCampaign campaigns · get · sending
updateCampaign campaigns · update · sending
deleteCampaign campaigns · delete · sending
getCampaignStats campaigns · stats · sending
getCampaignContentGuide campaigns · contentGuide · sending
previewCampaign campaigns · preview · sending
previewCampaignAudience campaigns · audience · sending
renderCampaignPreviewImage campaigns · previewImage · sending
getCampaignState campaigns · state · sending
setCampaignArchived campaigns · archive · sending
testCampaign campaigns · test · sending
sendCampaign campaigns · send · sending
scheduleCampaign campaigns · schedule · sending
cancelCampaign campaigns · cancel · sending
pauseCampaign campaigns · pause · sending
resumeCampaign campaigns · resume · sending
setCampaignPacing campaigns · pacing · sending
unscheduleCampaign campaigns · unschedule · sending
rescheduleCampaign campaigns · reschedule · sending
getWorkspaceSettings settings · get · admin
updateWorkspaceSettings settings · update · admin
getSesSettings settings · ses · admin
listDomains domains · list · admin
createDomain domains · create · admin
configureDomainMailFrom domains · mailFrom · admin
chooseReceivingHost domains · receivingHost · admin
sendDomainTestEmail Human step: sends only to the signed-in person’s own address. Agents use sendEmail.
getDomainDnsSetup Human step: Domain Connect opens the DNS provider in a browser. Agents can read the domain’s DNS records instead.
completeDomainDnsSetup Human step: the DNS provider redirects the person’s browser back.
getDomain domains · get · admin
deleteDomain domains · delete · admin
verifyDomain domains · verify · admin
listWebhooks webhooks · list · admin
createWebhook webhooks · create · admin
getWebhook webhooks · get · admin
updateWebhook webhooks · update · admin
deleteWebhook webhooks · delete · admin
revealWebhookSecret Human step: a signing secret is read back only in the dashboard or with an API key a person made, and every read is recorded. Agents can rotate it (webhooks · rotateSecret).
rotateWebhookSecret webhooks · rotateSecret · admin
testWebhook webhooks · test · admin
listWebhookDeliveries webhooks · deliveries · admin
getWebhookDelivery webhooks · delivery · admin
retryWebhookDelivery webhooks · retry · admin
receiveSesSnsEvent Signed by Amazon SNS; never an agent call.
unsubscribeByLink Recipient capability link; never an agent call.
unsubscribeOneClick Recipient one-click unsubscribe; never an agent call.
getMetrics usage · metrics · sending
getSenderScore usage · senderScore · sending
releaseSenderStanding Human step: an owner or admin confirms the fix checklist in the dashboard. Agents read the standing with getSenderScore.
getUsage usage · plan · sending
listRegions regions · list · admin
configureRegion regions · configure · admin
discoverRegion regions · discover · admin
provisionRegion regions · provision · admin
configureRegionAutoValidation regions · autoValidation · admin
getRouting routing · get · routing
applyRouting routing · apply · routing
listRoutes routes · list · routing
createRoute routes · create · routing
getRoute routes · get · routing
updateRoute routes · update · routing
deleteRoute routes · delete · routing
getRoutingAudit routing · audit · routing
listRoutingVersions routing · versions · routing
getRoutingVersion routing · version · routing
restoreRoutingVersion routing · restore · routing
testRouting routing · test · routing
listRitualVersions rituals · versions · rituals
restoreRitualVersion rituals · restore · rituals
setOmenOptIns rituals · omens · rituals
listEndpoints endpoints · list · endpoints
createEndpoint endpoints · create · endpoints
getEndpoint endpoints · get · endpoints
updateEndpoint endpoints · update · endpoints
deleteEndpoint endpoints · delete · endpoints
sendEndpointVerification endpoints · verify · endpoints
testEndpoint endpoints · test · endpoints
createInboxConnection connections · createInbox · inboxes
getRitualVersion Dashboard step: the rituals page’s long poll, so a person sees an agent’s saves live. Agents read the version from rituals · config (getRituals).
checkRitual rituals · check · rituals
getRitualTypings rituals · typings · rituals
listRitualTemplates rituals · templates · rituals
listRitualRecipes rituals · recipes · rituals
createRitualFromRecipe rituals · createFromRecipe · rituals
updateRitualFromRecipe rituals · updateFromRecipe · rituals
updateRitual rituals · update · rituals
getRitual rituals · get · rituals
saveRitual rituals · save · rituals
deleteRitual rituals · delete · rituals
attachRituals rituals · attach · rituals
getRituals rituals · config · rituals
applyRituals rituals · apply · rituals
testRituals rituals · test · rituals
listInboxFolders inboxes · folders · inboxes
createInboxFolder inboxes · createFolder · inboxes
updateInboxFolder inboxes · updateFolder · inboxes
deleteInboxFolder inboxes · deleteFolder · inboxes
updateInboxMessage messages · update · inboxes
deleteInboxMessage messages · delete · inboxes
getInboxMessage messages · get · inboxes
moveInboxMessage messages · move · inboxes
copyInboxMessage messages · copy · inboxes
expungeInboxFolder messages · expunge · inboxes
getInboxChanges inboxes · changes · inboxes
createInboxAppPassword inboxes · createPassword · inboxes
listInboxAppPasswords inboxes · passwords · inboxes
listAppPasswords inboxes · allPasswords · inboxes
revokeInboxAppPassword inboxes · revokePassword · inboxes
createInbox inboxes · create · inboxes
listInboxes inboxes · list · inboxes
getInbox inboxes · get · inboxes
updateInbox inboxes · update · inboxes
deleteInbox inboxes · delete · inboxes
simulateInboxMessage inboxes · simulate · inboxes
listInboxMessages messages · list · inboxes
getInboxAttachment attachments · getInbox · inboxes
releaseRetiredAddress addresses · release · inboxes
getInboundScanPolicy settings · inboundPolicy · admin
updateInboundScanPolicy settings · updateInboundPolicy · admin
listInboundDomains domains · listInbound · admin
getInboundDomain domains · getInbound · admin
updateInboundDomain domains · updateInbound · admin
checkInboundDomain domains · checkInbound · admin
enableInboundDomain domains · enableInbound · admin
disableInboundDomain domains · disableInbound · admin
listInboundSubdomains domains · listSubdomains · admin
createInboundSubdomain domains · createSubdomain · admin
getInboundSubdomain domains · getSubdomain · admin
updateInboundSubdomain domains · updateSubdomain · admin
removeInboundSubdomain domains · removeSubdomain · admin
listInboundAddresses addresses · list · inboxes
createInboundAddress addresses · create · inboxes
getInboundAddress addresses · get · inboxes
updateInboundAddress addresses · update · inboxes
deleteInboundAddress addresses · delete · inboxes
listInboundThreads threads · list · inboxes
createInboundThread reply · start · inboxes
getInboundThread threads · get · inboxes
updateInboundThread threads · update · inboxes
listInboundMessages messages · listInbound · inboxes
getInboundMessage messages · getInbound · inboxes
getInboundAttachment attachments · getInbound · inboxes
listLogs logs · all · sending
getInboundOverview addresses · overview · inboxes
replyToInboundThread reply · reply · inboxes
listInboundEvents messages · events · inboxes
createInboundKey keys · createInbound · admin
listInboundKeys keys · listInbound · admin
revokeInboundKey keys · revokeInbound · admin
createInboundWebhook inboundWebhooks · create · endpoints
listInboundWebhooks inboundWebhooks · list · endpoints
getInboundWebhook inboundWebhooks · get · endpoints
updateInboundWebhook inboundWebhooks · update · endpoints
deleteInboundWebhook inboundWebhooks · delete · endpoints
testInboundWebhook inboundWebhooks · test · endpoints
redeliverInboundMessage inboundWebhooks · redeliver · endpoints
rotateInboundWebhookSecret inboundWebhooks · rotateSecret · endpoints
retryInboundWebhookDelivery inboundWebhooks · retry · endpoints
listInboundWebhookDeliveries inboundWebhooks · deliveries · endpoints
listWorkspaces Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
createWorkspace Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
renameCurrentWorkspace Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
listWorkspaceMembers Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
inviteWorkspaceMember Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
createWorkspaceInvitation Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
listWorkspaceInvitations Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
revokeWorkspaceInvitation Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
updateWorkspaceMember Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
removeWorkspaceMember Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
getWorkspaceInvitation Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
acceptWorkspaceInvitation Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
getConnection Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
createConnection Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
deleteConnection Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
listConnectionRegions Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
refreshConnectionScan Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
importConnectionDomains Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
getConnectionRegionStatus Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
verifyConnection Human step: account administration in a signed-in dashboard session (members, invitations, workspaces, BYO AWS).
getPublicStats Public, installation-wide homepage numbers; no workspace data.
getOverviewSetup settings · setup · admin
listActivity Human step: a workspace’s Activity is for its signed-in owners and admins (Settings → Activity).
contactSupport Human step: a signed-in person contacts Nightmail support from the dashboard.
getBilling billing · get · admin
getBillingUsage billing · usage · admin
listBillingLedger billing · ledger · admin
listBillingPayments billing · payments · admin
getBillingPayment billing · payment · admin
createBillingTopUp Human step: only a signed-in owner or admin charges the saved card or opens Checkout from the dashboard. Agents create a link a person pays (billing · topUpLink).
createBillingTopUpLink billing · topUpLink · admin
updateBillingAutoRecharge Human step: auto-recharge spends from the saved card, so only a signed-in owner or admin sets it in the dashboard.
createBillingCardSetup Human step: a person saves a card in Stripe Checkout from the dashboard; card details never reach Nightmail or an agent.
deleteBillingPaymentMethod Human step: a signed-in owner or admin removes the saved card in the dashboard.