Sign up

API and MCP reference

562 operations in 27 areas. 513 of them are available to AI assistants over MCP.

Every operation runs as a signed-in person, with that person’s access. An assistant connected over MCP is limited in the same way, and risky changes wait for the person’s approval in Falcon.

Operations marked API only are steps a browser has to take itself, such as signing in, or addresses other services call.

This page is an overview, with one line for each operation.

Agent authoring and personal settings

Create and configure agents, review their work, manage invitations and maintain your personal settings.

  • Accept guide session MCP acceptGuideSession
  • Accepttransfer agent MCP accepttransferAgent
  • Agenda add MCP agenda_add
  • Agenda list MCP agenda_list
  • Agenda update MCP agenda_update
  • Answer guide session MCP answerGuideSession
  • Approves or rejects a tool that is waiting for review on an agent MCP approveAgentTool
  • Approves or rejects the changes waiting for review in one category of an agent MCP reviewAgentCategory
  • Archive agent MCP archiveAgent
  • Asks for access to an agent you can see but not open MCP requestAgentInvitation
  • Cancel background task MCP cancelBackgroundTask
  • Change an agent's chat window skin MCP putAgentWidgetSkin Replace the whole chat window skin of one agent at once: its colours in light and dark, font, corners, launcher, header and whether the powered-by line shows.
  • Changes an agent's instructions MCP updateAgentInstructions
  • Changes an agent's settings, voice and model MCP updateAgentSettings
  • Changes an agent's variables MCP updateAgentVariables
  • Changes how an agent writes on each channel MCP updateAgentChannelStyles
  • Changes the company's settings for the agenda tool MCP putAgendaSettings
  • Changes what an agent remembers and how MCP updateAgentMemory
  • Changes which agent this agent is built on MCP updateAgentBuiltOn
  • Changes which tools and knowledge searches an agent has MCP updateAgentTools
  • Changes who can see and edit an agent MCP updateAgentAccess
  • Changes your own preferences MCP updateUserPreferences
  • Changes your own profile MCP updateUserProfile
  • Compares two versions of an agent and shows what changed MCP compareAgentVersions
  • Create agent from template MCP createAgentFromTemplate
  • Create agent receiving address MCP createAgentReceivingAddress
  • Create agent test run MCP createAgentTestRun
  • Create guide session MCP createGuideSession
  • Create memory webhook MCP createMemoryWebhook
  • Create public link invitation MCP createPublicLinkInvitation
  • Creates a new agent MCP createAgent
  • Decline agent transfer MCP declineAgentTransfer
  • Delete an agent MCP deleteAgent Delete an agent for good.
  • Discard guide session MCP discardGuideSession
  • Disconnect connected app MCP disconnectConnectedApp
  • Download billing invoice MCP downloadBillingInvoice
  • Duplicate agent MCP duplicateAgent
  • Edit guide session MCP editGuideSession
  • Export agent content MCP exportAgentContent
  • Exports staff, community members or the audit log as CSV MCP exportCompanyCsv
  • Get company MCP getCompany Read the public company identity for the current host, including before sign-in.
  • Get guide session MCP getGuideSession
  • Get guide target MCP getGuideTarget
  • Get me MCP getMe
  • Import public link invitations MCP importPublicLinkInvitations
  • Inspect agent test run MCP inspectAgentTestRun
  • Invites a person to work on an agent MCP inviteAgentCollaborator
  • List connected apps MCP listConnectedApps
  • List memory deliveries MCP listMemoryDeliveries
  • List people MCP listPeople
  • List policies MCP listPolicies
  • List public link invitations MCP listPublicLinkInvitations
  • List roles MCP listRoles
  • Lists the agents a new agent can be built on MCP listAgentBases
  • Lists the agents you can see, with the ones you can open and the ones you can only see the name of MCP listAgents
  • Lists the models you can choose for an agent MCP listModelChoices
  • Pause agent MCP pauseAgent
  • Publishes the agent's current draft as a new version MCP publishAgent
  • Put agent channels MCP putAgentChannels
  • Put agent public entry MCP putAgentPublicEntry
  • Put agent voice settings MCP putAgentVoiceSettings
  • Reads your own preferences MCP getUserPreferences
  • Reads your own profile MCP getUserProfile
  • Reads your own sign-in methods and sessions MCP getUserSecurity
  • Removes your own access to an agent someone shared with you MCP leaveSharedAgent
  • Replay conversation steps MCP replayConversationSteps
  • Resend public link invitation MCP resendPublicLinkInvitation
  • Restore agent MCP restoreAgent
  • Reveal conversation words MCP revealConversationWords reveal Conversation Words Requires a reason and records an audit entry before revealing private conversation words.
  • Revoke public link invitation MCP revokePublicLinkInvitation
  • Save agent test case MCP saveAgentTestCase
  • Service disconnect connected app MCP serviceDisconnectConnectedApp
  • Service start connected app MCP serviceStartConnectedApp
  • Service test connected app event MCP serviceTestConnectedAppEvent
  • Shows a preview of the agent on one channel (chat, texts, email, WhatsApp or voice) MCP getStudioPreview
  • Signs you out of one session, or everywhere MCP revokeUserSession
  • Test agent phone channel MCP testAgentPhoneChannel
  • Transfer agent MCP transferAgent
  • Update agent knowledge searches MCP updateAgentKnowledgeSearches
  • Update agent tool settings MCP updateAgentToolSettings

Agents

Inspect agent configuration, inheritance, publication readiness and channel settings before making changes.

  • List a person's memory records MCP listAgentMemoryRecords List what an agent keeps in memory about one person: each record's kind, whose memory it is ('The person, everywhere' or 'The person, with each identity'), the path it is kept under and when it was kept.
  • List agent dependencies MCP listAgentDependencies Read the dependencies reported for this agent.
  • List agent images MCP listAgentImages Read the image records available on the agent and their revision.
  • List agent test cases MCP listAgentTestCases Read the agent's saved test cases and current revision.
  • List agent test runs MCP listAgentTestRuns Read recorded test-run summaries and their states.
  • List saved agent versions MCP listAgentVersions List version numbers, authors and the environments using each version.
  • Read a person's effective agent access MCP getEffectiveAgentAccess Read resolved permissions, category and section scope for the named person on this agent.
  • Read agent email and phone channels MCP getAgentChannels Read phone and email channel configuration, enabled state and readiness reasons.
  • Read agent instruction inheritance MCP getAgentInheritance Read the base chain, inherited parts and insertion points visible to the caller.
  • Read agent instruction sections MCP listAgentSections Read grouped instruction sections and their editable state.
  • Read agent instructions MCP getAgentInstructions Read the instruction content and revision visible to the caller.
  • Read agent knowledge searches MCP getAgentKnowledgeSearches Read configured knowledge searches, source filters, mode and enabled state.
  • Read agent lifecycle options MCP getAgentLifecycle Read lifecycle state and the actions currently described for this agent.
  • Read agent memory settings MCP getAgentMemory Read memory kinds, retention, processing steps, sharing destinations and lookup-tool settings, who shares each kind of memory ('The person, everywhere', 'The person, with each identity', 'A case' or 'The whole agent') and the path each kind is kept under.
  • Read agent public entry settings MCP getAgentPublicEntry Read public link, widget and app entry settings, usage limits and reported readiness.
  • Read agent publication readiness MCP getAgentPublish Read the current publication state and readiness information before publishing.
  • Read agent settings MCP getAgentSettings Read model selection, token and budget settings, input options and current revision.
  • Read agent sharing settings MCP getAgentAccess Read the agent access configuration and current revision under the caller's existing authority.
  • Read agent test choices MCP getAgentTestChoices Read the choices offered for configuring an agent test.
  • Read agent variable definitions MCP getAgentVariables Read the agent variable configuration and its revision.
  • Read agent voice settings MCP getAgentVoiceSettings Read voice configuration and reported limits, usage and readiness for the selected environment.
  • Read agent writing styles by channel MCP getAgentChannelStyles Read channel-specific instruction styles and their placement relative to shared sections.
  • Read an agent MCP getAgent Read the agent name, description, category, visibility and current revision.
  • Read an agent base selection MCP getAgentBuiltOn Read the selected base agent and inheritance settings.
  • Read an agent overview MCP getAgentOverview Read the agent overview with the state and summary information available to the caller.
  • Read an agent tool settings layer MCP getAgentToolSettings Read the settings and argument defaults explicitly configured for this agent and tool.
  • Read an agent's chat window skin MCP getAgentWidgetSkin Read the live chat window skin of one agent: its colours in light and dark, font, corners, launcher, header, whether the powered-by line shows, and whether the plan lets you hide it.
  • Read effective agent tool settings MCP getAgentEffectiveToolSettings Read merged tool settings with each value's source and lock state, plus the resulting model input schema.
  • Read skills bound to an agent MCP getAgentSkills Read bound skill references, versions and per-agent usage guidance and tool switches.
  • Read the impact of an agent base MCP getBuiltOnImpact Read the impact information for the agent's base relationship.
  • Read tools assigned to an agent MCP getAgentTools Read the tools assigned to this agent, their guidance and approval state.

AI guidance

Inspect published AI guidance.

  • List AI guidance MCP listFalconGuidance List AI guidance with the full text, declared variables and usage locations.
  • List saved guidance samples MCP listFalconGuidanceSamples Read example sample inputs and expected labels for this published guide.
  • Propose an AI guidance draft MCP proposeFalconGuidanceDraft Replace the registered content parts of a draft.
  • Publish an AI guidance draft API only publishFalconGuidanceDraft Publish the exact independently reviewed draft revision from the staff console with a fresh second step.
  • Read a guidance trial MCP getFalconGuidanceTrial Read a saved trial with the exact source guide and sample revision, answers and confidence.
  • Read AI guidance and its history MCP getFalconGuidance Read AI guidance and its history with the full text, declared variables and usage locations.
  • Read an AI guidance draft MCP getFalconGuidanceDraft Read the current draft and its review state without changing published guidance.
  • Review an AI guidance draft MCP reviewFalconGuidanceDraft Approve the exact draft revision as a staff member who contributed none of its edits.
  • Save a guidance sample MCP saveFalconGuidanceSample Save a example sample and expected labels with its current revision.
  • Try AI guidance on a saved sample MCP runFalconGuidanceTrial Run the current publication, an earlier published version or an exact saved draft revision against one saved example sample.

Approvals where people work

Choose where each kind of approval is asked — Studio, Slack, email, and later Microsoft Teams and text — and who is asked, and see who answered and where.

  • Change where approvals are asked MCP updateApprovalRouting Choose, for each approval rule, where it is asked (Studio is always included) and name the approvers asked outside Studio.
  • List approvals asked outside Studio MCP listApprovalAsks List the approvals asked in Slack or by email that you were asked or asked for: where they went, whether they were sent or recorded in test mode, who answered and how.
  • Read where approvals are asked MCP getApprovalRouting Read, for each approval rule, where it is asked and who is asked, and which channels are ready, switched off, need setting up or are designed only.

Ask Studio skills

See the playbooks Ask Studio follows for each part of the Studio, and add your company's own house rules and reference pages for it.

  • Change Ask Studio's house rules MCP updateAskStudioSkills Replace the company's Ask Studio house rules and reference pages.
  • Read Ask Studio's skills MCP getAskStudioSkills Read Ask Studio's built-in skills (name, when each applies, its intent and whether it always applies), with the company's house rules and reference pages.

Browser authentication and consent

Sign in, verify security challenges and review connected MCP clients.

  • Accept a membership invitation API only acceptInvitation Accept the invitation for the verified recipient.
  • Authorize an MCP connection API only authorizeMcpClient Grant a registered MCP client the permissions the person approved in the browser.
  • Cancel an MCP request API only cancelMcpPendingOperation Cancel a pending request without executing it.
  • Choose how phone codes are sent API only setPhoneTwoStepDelivery Choose text, RCS (where offered) or a voice call for the current person's phone codes.
  • Confirm an MCP request API only confirmMcpPendingOperation Approve execution of the exact pending request in its original browser review session.
  • Confirm the code and turn on phone two-step API only confirmPhoneTwoStep Confirm the code sent to the new number.
  • Disconnect an MCP client MCP revokeMcpConnection Revoke the selected MCP connection and its continued access.
  • Finish connecting a preset API only completeConnectorPreset Contract and synthetic fixture only.
  • Finish connecting an app API only serviceCompleteConnectedApp Company/person-bound single-use callback state.
  • Finish signing in API only completeSignIn Exchange the challenge response for a browser session.
  • Finish workspace setup API only completeWorkspaceSetup Save the workspace’s initial configuration after the setup challenge.
  • Hand a provider answer back to its company API only relaySignIn At the shared sign-in address, finish a Google or Microsoft answer for a sign-in started at another company address and return where to hand it back.
  • List your MCP connections MCP listMcpConnections Read the MCP clients connected by the current person.
  • Read a membership invitation API only getInvitation Look up a membership invitation using its invitation proof.
  • Read an MCP request awaiting review API only getMcpPendingOperation Read the exact pending request in the original browser review session.
  • Read an uncertain MCP request’s receipt API only reconcileMcpPendingOperation Read an execution receipt without repeating the uncertain action.
  • Read sign-in choices API only getSignInOptions Read the sign-in methods available for this workspace.
  • Read workspace setup API only getWorkspaceSetup Read the remaining setup required for this workspace.
  • Remove a security method MCP removeSecurityMethod Remove a security method after the required browser security check.
  • Replace backup codes MCP regenerateBackupCodes Invalidate the old backup codes and issue replacements for the current person.
  • Reset a person’s security methods MCP resetPersonFactors Reset the selected person’s security methods under current administrator authority.
  • Review an MCP connection request API only reviewMcpConsent Validate the registered client, redirect and requested permissions before browser consent.
  • Send a code to add a phone for two-step API only startPhoneTwoStep Send a six-digit code to a mobile number the current person is adding as a second step.
  • Send a phone code for a second step API only sendSecondStepPhoneCode Send a code to the current person's verified number for this sign-in or Confirm it's you flow.
  • Send a phone verification code API only startPhoneVerification Send a verification challenge to the current person’s phone.
  • Start a security check API only startStepUp Creates a ten-minute browser/session-bound challenge.
  • Start adding a security method API only beginSecurityEnrollment Create a challenge to enroll a passkey or another supported security method.
  • Start signing in API only startSignIn Create a sign-in challenge for the selected method.
  • Verify a new security method API only confirmSecurityEnrollment Verify the enrollment response and attach the security method to the current person.
  • Verify a phone number API only confirmPhoneVerification Verify the phone challenge and save the verified phone.
  • Verify a second sign-in step API only completeSecondStep Complete the current session’s second authentication challenge.

Branding

Work on the company's white-label look with your own assistant: the Studio theme (colours, type, logos, the sign-in page and email) and each agent's chat window skin. Every change is a draft you can preview, check for contrast and compare with live before a person publishes it in Studio.

  • Change an agent's draft skin MCP updateBrandingSkinDraft Change the draft chat window skin of one agent, never the live one.
  • Change the draft theme MCP updateBrandingThemeDraft Change the draft theme, never the live one.
  • Check the branding's contrast MCP getBrandingContrast Check the draft (or live) theme and an agent's skin against WCAG 2.1 AA: every text colour against every surface it sits on, in light and dark, with its measured ratio.
  • Compare the draft branding with live MCP compareBranding List what the draft changes against live: the tokens and logos you set, every drawn value that follows from them in light and dark, and, with an agent, each chat window setting that changes.
  • Discard an agent's draft skin MCP discardBrandingSkinDraft Throw an agent's draft skin away.
  • Discard the draft theme MCP discardBrandingThemeDraft Throw the draft theme away.
  • Get a signed link to upload a logo MCP createBrandingLogoUpload Get a short-lived, single-use link to upload a logo for light or dark.
  • Preview the draft branding MCP previewBranding Preview the draft theme and an agent's draft skin without changing anything live: returns a signed Studio link that shows the draft beside live in light and dark, what changes, the contrast result, and screenshots of the sign-in page, the agents list, an agent's page, the chat window and an email in light and dark as images.
  • Publish an agent's draft skin MCP publishBrandingSkin Make an agent's draft skin live on every site that embeds its chat window.
  • Publish the draft theme MCP publishBrandingTheme Make the draft theme live for everyone in the company: Studio, the sign-in page and company email.
  • Read a branding preview's pages MCP getBrandingPreview Read the pages of a preview made by previewBranding: each screen in light and dark, drafted and live, as self-contained pages with no scripts, plus what changes.
  • Read an agent's chat window skin MCP getBrandingSkin Read one agent's chat window skin: what is live, the draft being worked on (if any) and earlier live versions.
  • Read the company theme as design tokens MCP getBrandingTheme Read the company's Studio theme: the live tokens and logos, the draft being worked on (if any), both as DTCG design tokens for light and dark, every token a company may set with its default, and earlier live versions to roll back to.
  • Roll an agent's live skin back MCP rollbackBrandingSkin Make an earlier live skin, from history, live again.
  • Roll the live theme back MCP rollbackBrandingTheme Make an earlier live theme, from history, live again.

Change review

See exactly what changed in an agent, skill or workflow before it is published, and set the company's rules for changes to chosen categories and for reviewing workflows.

  • Approve or decline a workflow review MCP decidePipelineReview Approve or decline a workflow's review.
  • Approve or reject a skill draft for publishing MCP reviewSkillPublication Record a second person's decision on a skill draft whose category needs approval before publishing.
  • Ask for a review of a draft MCP requestChangeReview Tell the people who watch an agent or skill, and those who can approve it, that its draft is ready for review, with a short note.
  • Change the company's change rules MCP updateChangeRules Choose which instruction categories need an acknowledgement or a second person's approval before publishing, which always alert their owners, and when a workflow needs a review before it is published.
  • Comment on a workflow review MCP commentPipelineReview Add a comment to a workflow review, on one step or start or on the whole workflow.
  • List your change alerts MCP listChangeAlerts List alerts about agents, skills and categories you watch, newest first, each with what changed and the diff as you may see it.
  • Mark a change alert read MCP markChangeAlertRead Mark one of your change alerts as read.
  • Read a workflow's review MCP getPipelineReview Read whether a workflow needs a review before it is published, the latest review with its comments, who may review it, and the diff it is judged by.
  • Read the company's change rules MCP getChangeRules Read which instruction categories need an acknowledgement or a second person's approval before publishing, and which always alert their owners.
  • Read whether you are told about changes MCP getChangeWatch Read whether you are told about changes to an agent, a skill or an instruction category, and why: your own choice, a default for category owners and administrators, or a company rule.
  • Send a workflow for review MCP requestPipelineReview Ask a named person to review a workflow's draft before it is published.
  • Show what changed in a skill MCP getSkillDiff Compare a skill's draft or a published version with Live, with nothing, or with another published version, line by line.
  • Show what changed in a workflow MCP getPipelineDiff Compare a workflow's draft with its latest version, Live, nothing or a published version: each step and start line by line, and an 'Also changes' list of the agent versions it follows, connections, variables and limits.
  • Show what changed in an agent MCP getAgentDiff Compare an agent's draft or a published version with Live, with nothing, or with another published version, line by line.
  • Turn change alerts on or off MCP updateChangeWatch Choose whether you are told about changes to an agent, a skill or an instruction category.

Company administration

Manage company membership, security, appearance, billing and operating settings.

  • Accept company setup suggestions MCP companyAcceptGuideSession Apply the reviewed company setup guide result under the current caller’s settings authority and declared preconditions.
  • Add a company person MCP createCompanyPerson Create a membership record with the supplied name, address and role.
  • Add a GitHub installation MCP createCompanyGithubInstallation Record a GitHub installation and its repository access for this company.
  • Adds a cloud account to deploy agents to MCP createCompanyDeploymentAccount
  • Adds a payment method MCP createCompanyPaymentMethod
  • Adds an agent image MCP createCompanyImage
  • Answer a company setup question MCP companyAnswerGuideSession Submit an answer to the current company setup guide question and return the next guide state.
  • Applies the draft theme so everyone sees it MCP changeCompanyThemeApply
  • Change billing details MCP updateCompanyBilling Save the company’s billing details using their current revision.
  • Change email domain policy MCP updateCompanyDomainPolicy Replace the allowed and blocked email domain policy using its current revision.
  • Change MCP access policy MCP updateCompanyMcpPolicy Replace the company MCP policy with reviewed values using its current revision.
  • Changes a deployment account MCP updateCompanyDeploymentAccount
  • Changes a payment method MCP updateCompanyPaymentMethod
  • Changes a person's role or details MCP updateCompanyPerson
  • Changes an agent image MCP updateCompanyImage
  • Changes an invitation MCP updateCompanyInvitation
  • Changes the defaults for traveller payments MCP updateTravellerPaymentDefaults
  • Changes the draft theme MCP changeCompanyThemeDraft
  • Complete a privacy request MCP completeCompanyPrivacyRequest Mark or execute the requested completion under the privacy request’s current state and company policy.
  • Discard a company setup guide MCP companyDiscardGuideSession Discard the proposed company setup guide result without applying its suggested settings.
  • Edit a company setup answer MCP companyEditGuideSession Change a saved answer in the company setup guide before accepting its proposed settings.
  • Export a company package MCP exportCompanyPackage Make one package of this company's checks, identity fields, categories, company skills, agents and workflows, with the list of connections, numbers and identities the company importing it must supply.
  • Export authored content MCP exportCompanyAuthoredContent Request an export of authored content visible under the company’s current access policy.
  • Export the audit log MCP exportCompanyAudit Request an export of company audit records under the caller’s current audit permissions.
  • Goes back to an earlier theme MCP changeCompanyThemeRevert
  • Import a company package MCP importCompanyPackage Import a package as its preview said: add new items, update the items an earlier import of the same package made, and leave out refused items.
  • Invites a person to the company MCP createCompanyInvitation
  • List privacy requests MCP listCompanyPrivacyRequests List the company’s recorded privacy requests and their progress so authorized staff can handle them.
  • Lists earlier themes MCP listCompanyThemeHistory
  • Lists entries in the company's audit log MCP listCompanyAudit
  • Lists the choices available for agent images MCP getCompanyImageOptions
  • Lists the cloud accounts the company deploys agents to MCP listCompanyDeploymentAccount
  • Lists the company's agent images MCP listCompanyImage
  • Lists the company's invitations MCP listCompanyInvitation
  • Lists the company's payment methods MCP listCompanyPaymentMethod
  • Lists the design tokens a theme can change MCP getCompanyThemeTokens
  • Lists the filters and choices for the people list MCP getCompanyPeopleOptions
  • Lists the people in the company MCP listCompanyPerson
  • Makes a preview of the draft theme MCP changeCompanyThemePreview
  • Moderate company authors MCP moderateCompanyAuthors Apply the requested moderation action to the selected community authors.
  • Moves agents or instructions between categories, using a preview you made just before MCP applyCompanyCategoryChange
  • Open the billing portal MCP createBillingPortalSession Create a short-lived billing portal session for the company so an authorized person can manage payment details with the billing provider.
  • Preview a company package import MCP previewCompanyPackageImport Check every item in a package against this company: which it would add, which it would update because an earlier import (or an item with the same name or key) made them, which are unchanged, and which it would leave out and why.
  • Preview or invite many people MCP invitePeople Preview up to 500 invitation rows, then queue ready invitations after one recent second step.
  • Read a company setup guide MCP companyGetGuideSession Read the current question, answers and proposed settings for an existing company setup guide session.
  • Read billing details MCP getCompanyBilling Read company billing configuration and available invoice information.
  • Read company message topics MCP getCompanyMessageTopics Company message topics and their consent classification, quiet hours and daily limits.
  • Read company validation checks MCP getValidationChecks Read company-defined identity and input validation checks.
  • Read deployment details MCP getCompanyDeploymentDetails Read the deployment details for the supplied account and resource selection.
  • Read email domain policy MCP getCompanyDomainPolicy Read the company rules for allowed and blocked email domains before changing enrollment or invitation policy.
  • Read MCP access policy MCP getCompanyMcpPolicy Read who may connect MCP clients and which actions require confirmation under the current company policy.
  • Read Microsoft sign-in settings MCP getCompanyMicrosoftSignIn
  • Read the company plan MCP getCompanyPlan Read the current company plan and its limits before requesting a feature that depends on plan eligibility.
  • Reads one agent image MCP getCompanyImage
  • Reads one deployment account MCP getCompanyDeploymentAccount
  • Reads one invitation MCP getCompanyInvitation
  • Reads one payment method MCP getCompanyPaymentMethod
  • Reads one person MCP getCompanyPerson
  • Reads payment totals and defaults for traveller payments MCP getTravellerPaymentTotals
  • Reads the company's theme: the live one and any draft MCP getCompanyTheme
  • Reads the full details for one person MCP getCompanyPersonDetails
  • Record a privacy request MCP createCompanyPrivacyRequest Record a person’s requested privacy action for company handling.
  • Record Microsoft admin approval MCP completeCompanyMicrosoftConsent
  • Run a company action MCP actOnCompanyGeneral Run a supported company-level action against the current settings revision.
  • Run a connection action MCP actOnCompanyConnection Run a supported action on one company connection.
  • Run a data privacy action MCP actOnCompanyDataPrivacy Run a supported action on the company data privacy settings.
  • Run a deployment account action MCP actOnCompanyDeploymentAccount Run a supported action on a company deployment account.
  • Run a GitHub installation action MCP actOnCompanyGithubInstallation Run a supported action on a company GitHub installation.
  • Run a model settings action MCP actOnCompanyModelLimits Run a supported action on company model settings using the current revision.
  • Run a security action MCP actOnCompanySecurity Run a supported action on company security settings.
  • Run a single sign-on action MCP actOnCompanySso Run a supported action on the company’s single sign-on configuration.
  • Run a tool category action MCP actOnCompanyToolCategory Run a supported action on a company tool category.
  • Run an event source action MCP actOnCompanyEventSource Run a supported action on one company event source.
  • Run an MCP policy action MCP actOnCompanyMcpPolicy Run a supported action on the company MCP policy, subject to current company authority and the declared revision precondition.
  • Runs an action on a payment method, such as verify or remove MCP actOnCompanyPaymentMethod
  • Runs an action on a person, such as sign out everywhere or remove. The actions allowed depend on the person MCP actOnCompanyPerson Runs an action on a person, such as sign_out_everywhere or remove.
  • Runs an action on an agent image, such as build or remove. The actions allowed depend on the image MCP actOnCompanyImage Runs an action on an agent image, such as build or remove.
  • Runs an action on an invitation, such as resend or revoke MCP actOnCompanyInvitation
  • Save a connection credential MCP setCompanyConnectionsSecret Replace the write-only credential for one company connection.
  • Save a model credential MCP setCompanyModelsSecret Replace the write-only credential in company model settings.
  • Save an event source credential MCP setCompanyEventSourcesSecret Replace the write-only credential for one company event source.
  • Save company validation checks MCP putValidationChecks Replace company-defined checks used with built-in safety and field-fit checks.
  • Save Microsoft sign-in settings MCP putCompanyMicrosoftSignIn
  • Searches the company's audit log MCP searchCompanyAudit
  • Searches the company's people MCP searchCompanyPeople
  • Show what a company package carries MCP getCompanyPackages Read how many checks, identity fields, categories, company skills, agents and workflows a package from this company would carry, what never travels, and the packages imported here before.
  • Shows what moving agents or instructions between categories would change MCP previewCompanyCategoryChange
  • Signs a person out everywhere MCP signOutCompanyPerson
  • Start a company setup guide MCP companyCreateGuideSession Create a company setup guide session for the requested settings target.
  • Throws away the draft theme MCP changeCompanyThemeDiscard
  • Try a validation check MCP tryValidationCheck Evaluate sample text with one company-defined check and return the decision without saving the sample.
  • Update company message topics MCP updateCompanyMessageTopics Company message topics and their consent classification, quiet hours and daily limits.

Company closing

Close a company's account from the operator console: two people agree, and 30 days later its data is removed.

  • Cancel closing a company MCP cancelOperatorCompanyClosure Withdraw a proposal, or cancel a scheduled closing before its 30 days run out.
  • Confirm closing a company MCP confirmOperatorCompanyClosure Confirm another staff member's proposal.
  • List company closings MCP listOperatorCompanyClosures List every company closing that has been proposed, scheduled, withdrawn or cancelled, with who did each step and when the data goes.
  • Propose closing a company MCP proposeOperatorCompanyClosure Propose closing a company, with a reason.

Company self-serve sign-up

Create and review a new company workspace without granting production access before operator staff approval.

  • Approve a company sign-up MCP approveCompanySignupRequest Approve a verified request and create its limited workspace defaults.
  • List company email reputation guards MCP listEmailReputation Read rolling SES bounce and complaint rates and any automatic outbound-email pauses.
  • List company sign-up requests MCP listCompanySignupRequests Read verified company sign-ups waiting for operator staff approval.
  • Start a company sign-up API only startCompanySignup Submit company details, a verified mailbox and a processor-vault payment reference for a new workspace sign-up.
  • Unpause a company's outbound email MCP unpauseCompanyEmail After review, staff can clear a company's automatic email-reputation pause.
  • Verify a company sign-up API only verifyCompanySignup Verify the mailbox code sent for a company sign-up.

Connections

Inspect configured app and channel connections, sender readiness and tool grants.

  • Change company app sign-in settings MCP updateCompanyAppSettings Change between Falcon's client and the company's own client.
  • Change identity verification settings MCP updateIdentityVerificationSettings Change how checks work for every agent: the age the inquiry template checks, whether a finished check counts as verified, how long links work, when people verify again, and the notice sent with every link.
  • Connect a Persona account MCP saveIdentityVerificationAccount Connect the company's own Persona account for Dev (a sandbox key) or Live (a production key), with the inquiry template and the webhook secret.
  • Connect an Other email mailbox MCP createOtherEmailConnection Connect a hand-entered SMTP and IMAP mailbox after a mandatory test send; credentials are write-only and encrypted.
  • Create an incoming email map MCP createIncomingEmailMap Create an ordered email rule that maps a recipient, sender, subject or keyword to a workflow or agent.
  • Create an incoming request map MCP createIncomingRequestMap Create a signed, bounded request address that maps an incoming request to a workflow or agent.
  • Decide on a held email MCP decideHeldIncomingEmail Start a held or skipped email anyway (its email map's target runs once), mark it as spam, or dismiss it.
  • Delete an incoming request map MCP deleteIncomingRequestMap Delete a request map.
  • Disconnect a Persona account MCP removeIdentityVerificationAccount Disconnect an environment's Persona account and schedule its key and webhook secret for deletion.
  • Disconnect an Other email mailbox MCP disconnectOtherEmailConnection Disable a mailbox and remove stored credentials.
  • List a connection's tool choices MCP listToolConnectionChoices List tools available through a selected connection.
  • List available message senders MCP listSendingSenders List senders and their declared channel readiness.
  • List company message keys MCP listCompanyMessageKeys Read message-key metadata and configured state.
  • List connected app deliveries MCP serviceListConnectedAppDeliveries Inspect recorded deliveries for an app connection.
  • List connected apps MCP serviceListConnectedApps List app connections visible in the current company scope.
  • List connection presets MCP listConnectorPresets List reusable connection presets.
  • List held incoming email MCP listHeldIncomingEmails Read the emails the check before a run held or skipped: each email's kind, how sure the check was, its email map, its files kept and not kept, and when it arrived and expires.
  • List incoming email maps MCP listIncomingEmailMaps Read the ordered rules that route inbound email, the addresses assigned to agents and identities, and the company's forwarding or MX setup.
  • List incoming request maps MCP listIncomingRequestMaps Read request maps, their rotatable addresses and recent accepted, ignored or refused results.
  • List labelled incoming email MCP listIncomingEmailLabels Read what people said held and skipped emails really were, next to what the check said, for checking the filter later.
  • List SendGrid connections MCP listSendGridConnection List configured SendGrid connections and their status.
  • List twilio connections MCP listTwilioConnections List configured Twilio connections and their status.
  • List what request map targets receive and give back MCP listIncomingRequestTargets Read every workflow or agent a request map can start: its declared start fields, the steps that receive them first, what it gives back, and JSON Schemas for its input and response generated from its definition and versioned with it.
  • Read a connected app MCP serviceGetConnectedApp Read an existing app connection's label, state and configuration.
  • Read a connection preset MCP getConnectorPreset Read a preset's provider and connection requirements.
  • Read a person's verification MCP getPersonVerification Read what one person's identity check came to in Dev or Live: its status, the age it confirmed, when it was verified and expires, and Persona's inquiry id.
  • Read a SendGrid connection MCP getSendGridConnection Inspect a SendGrid connection's configured state.
  • Read a Twilio connection MCP getTwilioConnection Inspect a Twilio connection's configured state.
  • Read an app event example MCP getAppCloudEventExample Inspect the app event envelope.
  • Read company app sign-in settings MCP getCompanyAppSettings Read the sign-in choice and identity-connectability flag.
  • Read company messaging rules MCP getCompanyMessagingRules Read the message kinds and sending rules that apply.
  • Read identity verification MCP getIdentityVerification Read the company's Persona connection for Dev and Live (whether each is connected, its inquiry template, the key's last four characters and the webhook address to add in Persona) and how checks work: the age the template checks, whether a finished check counts, how long links work, when people verify again and the notice sent with each link.
  • Read message-key tool grants MCP getMessageKeyToolGrants Read which tools a message key may use.
  • Read one saved Other email mailbox MCP getOtherEmailConnection Read mailbox status and last test without credentials.
  • Read saved Other email mailboxes MCP listOtherEmailConnections Read mailbox status, addresses and the last provider test without credentials.
  • Read the company webhook endpoint MCP getCompanyWebhookEndpoint Inspect the configured shared webhook endpoint.
  • Receive a mapped incoming request API only receiveIncomingRequest Verify and map a signed incoming request, sent as JSON or form fields.
  • Receive an identity verification result API only serviceReceiveIdentityVerificationEvent Receive a Persona webhook event for the company's Dev or Live account.
  • Revoke a person's verification MCP revokePersonVerification Take back a person's verification in Dev or Live, with a reason, and optionally ask Persona to delete the check's personal data.
  • Rotate an incoming request address MCP rotateIncomingRequestMap Rotate a request map address while retaining its mapping and target.
  • Show a held email's excerpt MCP revealHeldIncomingEmail Show the subject and a short excerpt of one held or skipped email.
  • Update an incoming email map MCP updateIncomingEmailMap Change an email map's matching rule or target while retaining its inbound address.
  • Update an incoming request map MCP updateIncomingRequestMap Change the target, verification, conditions or mapping without changing the request address.

Docs

Search the product docs and read any page in full, so an assistant can answer how-to questions from the same pages people read.

  • Read a docs page MCP readDocPage Read one docs page in full, as Markdown.
  • Search the docs MCP searchDocs Find the docs sections that best match some words, best first, each with the page to read in full.

Editing by email

Change an agent's instructions or a company skill by emailing its edit address, or email the company's Studio address for anything you could change in Studio. The Studio assistant reads the email as the sender, drafts the change and replies with it before anything is saved.

  • Change editing by email MCP updateEmailEditSettings Turn personal edit addresses on or off, and choose whether the company address may propose any change the sender could make in Studio ('Email Studio can propose any change', on by default).
  • Confirm an emailed change MCP confirmEmailEdit Confirm the change drafted from an email with the one-time token from its confirmation link.
  • Confirm an emailed plan API only confirmEmailEditReview Apply the whole plan an email to the company's Studio address produced, as the person who sent it.
  • Issue an edit address MCP issueEmailEditAddress Issue the edit address for one agent, one skill, or, naming neither, the company-wide address.
  • Read an edit address MCP getEmailEditAddress Read the edit address for one agent, one skill, or, naming neither, the company-wide address; null until one is issued.
  • Read an emailed plan to review API only getEmailEditReview Read the plan an email to the company's Studio address produced beyond drafts of instructions and skills: each change with its diff and, for a request with many steps, the steps Studio is drafting.
  • Read editing by email MCP getEmailEditSettings Read whether editing by email is on, whether personal edit addresses are required, whether the company address may propose any change, the company-wide address and how many emails were dropped or refused.

Identities

Manage people and places that agents act for.

  • Choose an identity binding's RCS sender MCP updateCompanyIdentityBindingRcs Attach an identity RCS registration or return the binding to the agent's shared sender.
  • Choose company binding calendars MCP updateCompanyIdentityBindingCalendar Choose which already granted calendars narrow this identity binding’s working hours.
  • Choose personal binding calendars MCP updatePersonalIdentityBindingCalendar Choose which already granted calendars narrow this identity binding’s working hours.
  • Commit a company identity import MCP commitCompanyIdentityImport Write reviewed rows as drafts bound to no agent, applying explicit update or skip decisions to code-then-email matches.
  • Find who a person is with MCP findIdentityTurn Find which identity a person is with in a pool, by one of their proved contact points.
  • Move a person to another identity MCP reassignIdentityTurn Move one person, found by a proved contact point, to another identity bound to this agent.
  • Preview a company identity import MCP previewCompanyIdentityImport Read CSV or JSON identity rows, apply adjustable header mapping, validate every row and show code-then-email matches without writing identities or sending mail.
  • Preview an identity RCS registration MCP previewCompanyIdentityBindingRcsRegistration Preview the RCS registration builder pre-filled from identity fields.
  • Read a company binding address test MCP getCompanyIdentityBindingTest Test only the current receiving email, SIP address or attached number of an enabled binding.
  • Read a personal binding address test MCP getPersonalIdentityBindingTest Test only the current receiving email, SIP address or attached number of an enabled binding.
  • Read an identity binding's RCS sender MCP getCompanyIdentityBindingRcs Read the agent-shared or identity-dedicated RCS choice, approval status and identity sign-off.
  • Read company binding calendar status MCP getCompanyIdentityBindingCalendar Read the calendars selected for this binding and the last successful refresh time.
  • Read personal binding calendar status MCP getPersonalIdentityBindingCalendar Read the calendars selected for this binding and the last successful refresh time.
  • Report on taking turns MCP getIdentityTurns New conversations per identity over the last seven days, why each identity got them (its turn, a returning person, the fallback, a switch or a move by hand), open conversations, today's count against its daily cap, and people moved between identities.
  • Request a company binding address test MCP createCompanyIdentityBindingTest Test only the current receiving email, SIP address or attached number of an enabled binding.
  • Request a personal binding address test MCP createPersonalIdentityBindingTest Test only the current receiving email, SIP address or attached number of an enabled binding.
  • Simulate a new conversation API only simulateIdentityTurn Fixture mode only.

Knowledge

Inspect knowledge bases, their sources and synchronization progress.

  • Ask about documents MCP askAboutDocuments Ask one registered yes/no or pick-one question about referenced items without loading their content into the agent context.
  • List knowledge bases MCP listKnowledgeBase List knowledge bases and their source summaries.
  • List knowledge sources MCP listKnowledgeSource List sources configured for a knowledge base.
  • List knowledge syncs MCP listKnowledgeSyncs Read recorded synchronization attempts for a knowledge base.
  • Read a knowledge base MCP getKnowledgeBase Inspect a knowledge base's configuration, source counts and revision.
  • Read a knowledge source MCP getKnowledgeSource Inspect a source's location, schedule, tags and current state.

Model controls

Pause model calls and set the run ceilings every new run starts with, from the operator console.

  • Force or release the decisions fallback MCP setOperatorDecisionFallback Skip jev everywhere and use each job's fallback, or go back to jev.
  • Pause or resume model calls MCP setOperatorModelCallSwitch Pause or resume model calls for everyone, one provider, one company or one agent.
  • Read decision provider health MCP getOperatorDecisionHealth Read each decisions provider's health (jev, OpenAI Decisions, the model judge): whether its circuit breaker is closed, open or probing, recent failures and latency, and whether the fallback is forced.
  • Read model-call switches and run ceilings MCP getOperatorModelControls Read every model-call pause switch that has been set, the providers that can be paused, and the run ceilings new runs start with.
  • Set run ceilings MCP setOperatorRunCeilings Set the turns, tool calls, tokens per turn, time and delegation depth each new run may use, up to this deployment's maximum.

Partners

Manage consented partner access to client companies.

  • Accept a partner invitation MCP acceptPartnerInvitation Accept a pending partner invitation as a client administrator.
  • Add partner staff MCP invitePartnerStaff Add an existing active member of the partner company as partner staff.
  • Approve a client’s usage markup, display and service lines MCP updateClientUsageTerms
  • Approve a partner account MCP approvePartnerAccount
  • Assign staff to a client MCP assignPartnerStaff Assign active staff to a consented client.
  • Change a partner staff role MCP updatePartnerStaffRole
  • Create a partner account MCP createPartnerAccount Create a staff-approved partner account.
  • Export monthly client usage and margin MCP exportPartnerClientSummaries
  • Invite a partner to a client MCP createPartnerInvitation Create a consent invitation from a partner to a client company.
  • List client assignments MCP listPartnerAssignments
  • List companies you can open MCP listMySwitchableCompanies List the partner console and clients you are currently assigned to, at their registered Studio addresses.
  • List partner clients MCP listPartnerClients List client companies linked to a partner.
  • List partner people in this company MCP listCompanyPartnerStaff Show assigned partner people with the partner marker, effective role permissions and client-owned exclusion revision.
  • List partner staff MCP listPartnerStaff
  • List partners with client access MCP listCompanyPartnerAccess Show client administrators which partners can act in this company.
  • Read a client’s agreed usage and support terms MCP getClientUsageTerms
  • Read monthly client usage and margin MCP listPartnerClientSummaries
  • Read this company’s usage at its partner’s prices MCP getCompanyUsageReport
  • Remove a client assignment MCP removePartnerAssignment
  • Remove a partner person from this company MCP removeCompanyPartnerStaff Record a durable client-owned exclusion for one partner person.
  • Remove partner staff MCP removePartnerStaff
  • Revoke partner access MCP revokePartnerAccess Revoke a partner's delegated access in the current client company.

Pricing

Set the markup the operator adds to measured cost, and see cost, markup and margin per company.

  • Confirm a markup change MCP confirmOperatorMarkupChange Confirm a markup change another member of staff proposed.
  • Export cost, markup and margin MCP exportOperatorPricingMargins Export each company's cost, markup, price and margin for a month as CSV.
  • Propose a markup change MCP proposeOperatorMarkupChange Propose a markup percentage for the default, a company or a partner, from a chosen date forward.
  • Read cost, markup and margin MCP getOperatorPricingMargins Read each company's measured cost, markup, price and margin for a month, priced with the markup in force when each unit was measured.
  • Read pricing MCP getOperatorPricing Read the default markup, each company's and partner's markup in force, every dated change and the lines that are off.
  • Set how a company sees its price MCP setOperatorCompanyPriceDisplay Choose whether a company's billing shows cost and markup separately (itemised) or only its price (combined).
  • Withdraw a markup change MCP withdrawOperatorMarkupChange Withdraw a markup change that is still waiting for confirmation.

Tools, knowledge and workflow authoring

Configure reusable skills, tools, connections, knowledge, storage, workflows and reports.

  • Adds a connection to another MCP server MCP createRemoteMcpConnection
  • Adds a source to a knowledge base MCP createKnowledgeSource
  • Adds a storage connection MCP createStorageConnection
  • Adds a webhook to a workflow MCP createPipelineWebhook
  • Adds something that starts a workflow MCP createPipelineTrigger
  • Archive a workflow MCP archivePipeline Archive a workflow you no longer use.
  • Cancel report schedule MCP cancelReportSchedule
  • Cancel workflow run MCP cancelPipelineRun
  • Changes a company skill's draft MCP updateCompanySkill
  • Changes a company tool MCP updateCompanyTool
  • Changes a connection to another MCP server MCP updateRemoteMcpConnection
  • Changes a file store MCP updateFileStore
  • Changes a knowledge base MCP updateKnowledgeBase
  • Changes a knowledge source MCP updateKnowledgeSource
  • Changes a storage connection MCP updateStorageConnection
  • Changes a workflow webhook MCP updatePipelineWebhook
  • Changes the company's settings for the get file tool MCP updateGetFileSettings
  • Changes the company's settings for the list files tool MCP updateListFilesSettings
  • Changes the company's settings for the save file tool MCP updateSaveFileSettings
  • Changes the skills an agent uses and when it uses them MCP updateAgentSkills
  • Changes which tools a message key may use MCP updateMessageKeyToolGrants
  • Check twilio connection MCP checkTwilioConnection
  • Checks that a storage connection works MCP checkStorageConnection
  • Connect connector preset MCP connectConnectorPreset
  • Create falcon code repository MCP createFalconCodeRepository
  • Create report schedule MCP createReportSchedule
  • Create send grid connection MCP createSendGridConnection
  • Create twilio connection MCP createTwilioConnection
  • Creates a company skill MCP createCompanySkill
  • Creates a file store MCP createFileStore
  • Creates a knowledge base MCP createKnowledgeBase
  • Creates a new company skill and adds it to an agent in one step MCP createAndBindAgentSkill
  • Defines a new company tool MCP createCompanyTool
  • Delete a company skill MCP deleteCompanySkill Delete a skill from the company library.
  • Delete a knowledge base MCP deleteKnowledgeBase Delete a knowledge base with its documents and search index.
  • Delete a workflow MCP deletePipeline Delete a workflow for good.
  • Disconnect remote connector MCP disconnectRemoteConnector
  • Export report MCP exportReport
  • Get agent daily cost cap MCP getAgentDailyCostCap
  • Get agent skill derivation MCP getAgentSkillDerivation
  • Get cost report MCP getCostReport
  • Get report schedules MCP getReportSchedules
  • Get workflow event example MCP getPipelineEventExample
  • Get workflow raise example MCP getPipelineRaiseExample
  • Get workflow report MCP getPipelineReport
  • Get workflow version MCP getPipelineVersion
  • List knowledge base choices MCP listKnowledgeBaseChoices
  • Lists a workflow's webhooks MCP listPipelineWebhooks
  • Lists the company's skills MCP listCompanySkills
  • Lists the company's workflows MCP listPipelines
  • Lists the knowledge bases a connection can reach, so you can add them MCP discoverKnowledgeBases
  • Lists the tools and knowledge searches you can add to an agent MCP listToolCatalog
  • Lists what starts a workflow MCP listPipelineTriggers
  • Makes a copy of a company skill MCP duplicateCompanySkill
  • Moves a company tool through review and release: submit it for review, approve it, publish it or retire it MCP actOnTool
  • Publishes a skill's draft as a new version MCP publishCompanySkill
  • Put tool webhook signing MCP putToolWebhookSigning
  • Put twilio connection MCP putTwilioConnection
  • Reads a skill's published versions and whether its draft is ready to publish MCP getCompanySkillPublication
  • Reads one company skill MCP getCompanySkill
  • Refresh tool catalog MCP refreshToolCatalog
  • Reschedule workflow run MCP reschedulePipelineRun
  • Resolve tool ui action MCP resolveToolUiAction
  • Restores an older workflow version as the draft. To change Live, make an older version live instead MCP rollbackPipeline Restores an older workflow version as the draft.
  • Retry workflow run MCP retryPipelineRun
  • Runnow workflow run MCP runnowPipelineRun
  • Runs a test call of a company tool. Repeat the same call with the same idempotency key to read its result MCP testCompanyTool Runs a test call of a company tool.
  • Select connector tools MCP selectConnectorTools
  • Shows the tool a workflow's agents use to report the exceptions the workflow declares MCP getPipelineExceptionTool
  • Starts syncing a knowledge base from its sources MCP startKnowledgeSync
  • Test knowledge search MCP testKnowledgeSearch
  • Test send grid connection MCP testSendGridConnection
  • Test workflow MCP testPipeline
  • Update agent skill derivation MCP updateAgentSkillDerivation
  • Update company messaging rules MCP updateCompanyMessagingRules
  • Update company webhook endpoint MCP updateCompanyWebhookEndpoint
  • Update falcon code repository MCP updateFalconCodeRepository
  • Update report schedule MCP updateReportSchedule
  • Update send grid connection MCP updateSendGridConnection
  • Update step tool settings MCP updateStepToolSettings
  • Update tool implementation choice MCP updateToolImplementationChoice
  • Update tool sign in MCP updateToolSignIn

Run label index

Make run labels kept before the label index existed findable in a workflow's run search, from the operator console.

  • Index older run labels MCP backfillOperatorRunLabelIndex Index one company's run labels that were kept before the label index existed, so run search finds them.

Service callbacks and client transport

Receive authenticated callbacks and exchange conversation and workflow data.

  • Accept a signed guest invitation API only acceptPublicGuestInvitation Accept a single-use signed invitation proof without Studio sign-in.
  • Accept a signed tool event API only acceptToolCallEvent Message-key grants default empty.
  • Add an agenda item from a company server API only addPersonAgenda Contract and synthetic fixture only.
  • Get a reply stream ticket API only createClientStreamTicket Exchange the session Bearer, sent in the Authorization header, for a ticket that opens this session's reply stream once.
  • List a person’s agenda MCP listPersonAgenda Read the agenda items for the referenced person under current conversation-read permission.
  • Prepare a conversation upload API only createClientUpload Synthetic client exchange.
  • Raise a signed workflow exception API only raisePipelineException Contract and synthetic fixture only.
  • Read a private company theme PNG MCP getCompanyThemeAsset Read an authorized company theme asset as PNG bytes.
  • Read a voice session API only getVoiceSession Read a voice session started with this client session Bearer: whether it is ready, live or ended, why it ended, its length limit and the seconds used so far.
  • Read a workflow run by its server reference MCP fetchPipelineRun Read a workflow run within the caller’s permitted scope.
  • Read conversation events API only getClientEvents Deprecated: the session value in this path can reach load balancer and CDN access logs.
  • Read the reply stream with a ticket API only getClientStream Read a client session's replies as server-sent events, opened with a ticket from createClientStreamTicket.
  • Receive a tool completion callback API only receiveToolWebhookCallback Bound to tenant, waiting call/version and output schema.
  • Start talking in a chat session API only startVoiceSession Start voice in the conversation a client session Bearer names: the public widget, a public link, or a session your own server exchanged for a person with its message key.
  • Stop talking API only endVoiceSession End a voice session started with this client session Bearer.
  • Upload conversation content API only putClientUpload Synthetic client exchange.

Storage

Inspect file stores, storage configuration and file-tool examples.

  • List file expiry folders MCP listExpiryFolders Inspect configured expiry folders and retention rules.
  • List file stores MCP listFileStore List the company's file stores and their connection assignments.
  • List storage connections MCP listStorageConnection List configured storage connections and their readiness.
  • Read a file move job MCP getFileMoveJob Inspect an existing file move job's progress.
  • Read a file store MCP getFileStore Read a file store's location, settings and revision.
  • Read a file-listing example MCP getListFilesExample Inspect example file-listing arguments and results.
  • Read a file-reading example MCP getReadFileExample Inspect example file-reading arguments and results.
  • Read a save-file example MCP getSaveFileExample Inspect example save-file arguments and results.
  • Read a storage connection MCP getStorageConnection Inspect a storage connection's configuration and security status.
  • Read a storage policy MCP getStoragePolicy Read the required storage policy for a selected connection.
  • Read get-file tool settings MCP getGetFileSettings Inspect the get-file tool's configured access and defaults.
  • Read list-files tool settings MCP getListFilesSettings Inspect the list-files tool's configured scope and defaults.
  • Read save-file tool settings MCP getSaveFileSettings Inspect destination and file-handling settings.

Studio address and custom domain

Each company has one Studio address. Read it, ask to move it to a domain the company owns, prove the domain with a DNS record, and remove the domain again.

  • Ask to move Studio to a custom domain MCP setCompanyStudioDomain Name a domain the company owns for its Studio and get the TXT record that proves it.
  • Check the custom domain's DNS record MCP checkCompanyStudioDomain Look for the TXT record now.
  • Read the company's Studio address MCP getCompanyStudioAddress Read where the company's Studio answers, and any custom domain it is moving to with the DNS records still needed.
  • Remove the custom domain MCP removeCompanyStudioDomain Drop a custom domain request, or stop using a custom domain in use; the company's Studio then answers at its subdomain again and people sign in there.

Ask Studio and MCP usage

See what Ask Studio and connected MCP clients cost this month, per person, per client and per operation, and set the company's monthly caps and kill switch.

  • Change Ask Studio and MCP limits MCP updateStudioUsageLimits Set each person's and each connected client's monthly cap for Ask Studio and MCP calls, or turn the kill switch on or off.
  • Read Ask Studio and MCP usage MCP getStudioUsage Read a month's Studio assistant and MCP calls lines, with each person, each connected client and the costliest operations, and the caps in force.

Tools

Inspect tool definitions, safeguards, task progress and integration examples.

  • Ask one question across GitHub files MCP askGithubFiles Ask one registered question over bounded GitHub file items at an immutable commit.
  • Find relevant github files MCP findRelevantGithubFiles Rank relevant files in a connected GitHub repository at an immutable commit without returning repository content.
  • List built-in tool definitions MCP listBuiltInToolDefinitions Inspect the built-in tool kinds and their configuration fields.
  • List company tools MCP listCompanyTool List tool definitions, safeguards and publication state.
  • List connected code repositories MCP listFalconCodeRepository List the connected repositories available for code tools.
  • List remote mcp connections MCP listRemoteMcpConnections List configured remote MCP connections and their status.
  • List tool implementation choices MCP listToolImplementationChoices Compare the available backend kinds.
  • List tool interface action kinds MCP listToolUiActionKinds Inspect the supported interface action kinds.
  • Read a background task MCP getBackgroundTask Read an existing task's progress and result using its task identifier.
  • Read a background task event example MCP getBackgroundTaskEventExample Inspect a task progress event's shape.
  • Read a company tool MCP getCompanyTool Read a tool's input and output shapes, backend, safeguards and current revision.
  • Read a connected code repository MCP getFalconCodeRepository Inspect a connected repository's configuration and state.
  • Read a recorded tool call MCP getToolCallRecord Read the status and permitted result of an existing tool call using its call identifier.
  • Read a remote MCP connection MCP getRemoteMcpConnection Read a configured remote MCP connection and its status.
  • Read a tool completion event example MCP getToolEventBridgeCompletionExample Inspect the completion event format for a tool that finishes asynchronously.
  • Read a tool interface action example MCP getToolUiActionExample Read an example of a tool result that requests an interface action.
  • Read a tool webhook callback example MCP getToolWebhookCallbackExample Inspect the callback shape used to complete a deferred tool call.
  • Read a tool webhook request example MCP getToolWebhookRequestExample Inspect the request shape a tool webhook receives.
  • Read a tool's sign-in requirements MCP getToolSignIn Inspect the connection and sign-in requirements for a tool.
  • Read agenda tool settings MCP getAgendaSettings Inspect the agenda tool's configured defaults.
  • Read an agenda event example MCP getAgendaEventExample Inspect the declared agenda event shape.
  • Read background task limits MCP getBackgroundTaskLimits Inspect the configured task limits.
  • Read email shared-sender reply settings MCP getEmailMessagingSettings Read Send email settings, including what to do when a reply could be for more than one open conversation.
  • Read Slack shared-sender reply settings MCP getSlackMessagingSettings Read Slack sender settings, including what to do when a reply could be for more than one open conversation.
  • Read Telegram shared-sender reply settings MCP getTelegramMessagingSettings Read Telegram sender settings, including what to do when a reply could be for more than one open conversation.
  • Read text shared-sender reply settings MCP getTextMessagingSettings Read text sender settings, including what to do when a reply could be for more than one open conversation.
  • Read tool call examples MCP getToolCallExamples Read example arguments and results to understand a tool's declared interface.
  • Read tool editing options MCP getCompanyToolOptions Read icon choices and current safeguard authority.
  • Read tool publication state MCP getToolPublication Inspect the saved tool versions and their publication state.
  • Read tool webhook signing status MCP getToolWebhookSigning Read webhook signing configuration and key status.
  • Read WhatsApp shared-sender reply settings MCP getWhatsappMessagingSettings Read WhatsApp sender settings, including what to do when a reply could be for more than one open conversation.
  • Set email shared-sender reply settings MCP putEmailMessagingSettings Save Send email settings for replies that could be for more than one open conversation.
  • Set Slack shared-sender reply settings MCP putSlackMessagingSettings Save the Slack sender setting for replies that could be for more than one open conversation.
  • Set Telegram shared-sender reply settings MCP putTelegramMessagingSettings Save the Telegram sender setting for replies that could be for more than one open conversation.
  • Set text shared-sender reply settings MCP putTextMessagingSettings Save the text sender setting for replies that could be for more than one open conversation, including the seven-day recent window.
  • Set WhatsApp shared-sender reply settings MCP putWhatsappMessagingSettings Save the WhatsApp sender setting for replies that could be for more than one open conversation.

Workflows

Inspect settings saved on workflow steps and the values they inherit.

  • Adopt a Gmail reply draft agent MCP adoptGmailReplyDraftTemplate Create and publish a Dev reply draft workflow using an existing immutable agent publication containing only the reviewed draft instructions.
  • Create a call-recording-ready workflow starter MCP createCallRecordingStarter Create a workflow that starts when a call recording is ready, and make it Live.
  • Install the Gmail reply draft workflow MCP installGmailReplyDraftTemplate Install reviewed draft instructions on an unused root agent, publish its immutable Dev version and create the reply draft workflow.
  • Read effective workflow step tool settings MCP getStepEffectiveToolSettings Read a step's resolved tool settings and their sources.
  • Read workflow step tool settings MCP getStepToolSettings Read the settings saved directly on a workflow step.
  • Receive a finished call recording API only receiveCallRecording Receive a provider-signed finished recording notification for the transcript and report starter.