Supported Tools
Full reference for all 234 tools the Fours MCP Server gives an assistant you connect.
The Fours MCP Server gives an assistant you connect 234 tools that cover the public Fours API, your revenue records, receivables, payouts and credit memos, your analytics data with its saved charts and dashboards, and your funding applications, integrations and workflow runs — from listing products and managing entitlements to running the entire co-sell referral lifecycle across AWS, Azure, GCP and Fours partner companies, and running your partner program: partners, invitations, journeys, tasks, training, agreements, events, shared files and the program’s settings. Your AI assistant automatically discovers available tools and their parameters when it connects. You can combine multiple tools in a single conversation to accomplish complex, multi-step workflows.
Organization (5)
| Tool | Description | Example Prompt |
|---|---|---|
ListOrganizations | List organizations | “Show my organizations” |
ListUsersByOrganization | List the organization’s users — ID, name, email, role, and login and join times; use it to find a user’s ID from their email | “Who are the users in our organization, and what are their roles?” |
GetOrganizationLicensesAndServices | Get the organization’s enabled services and quota limits | “What services and quotas does my org have?” |
GetOnboardingStatus | Get the organization’s Get Started checklist — which steps are complete, with the reason for any that aren’t | “Which Get Started steps do we still need to finish?” |
UpdateOnboardingInfo | Skip or un-skip Get Started steps, or dismiss the checklist, for the whole organization | “Skip the CRM step on our Get Started checklist” |
UpdateOnboardingInfo replaces the whole skippedSteps list and applies to everyone in the
organization, so have your assistant read the current list with GetOnboardingStatus, change it,
and write it back in one go.
Product Management (14)
| Tool | Description | Example Prompt |
|---|---|---|
ListProducts | List products | “List all my products” |
ListProductsByPartner | List products by cloud partner | “Show all AWS products” |
QueryProducts | Query products with filters | “Find products with status PUBLISHED” |
GetProduct | Get product details | “Get details for product prod-123” |
CreateProduct | Create a new product | “Create a SaaS product for AWS Marketplace” |
CreateOrUpdateDraftProduct | Save a draft product | “Save a draft product listing” |
UpdateProduct | Update a product | “Update the description for my product” |
UpdateProductMetaInfo | Update product metadata | “Update product metadata” |
UpdateProductPricing | Update product pricing / terms | “Update pricing for product prod-123” |
UpdateProductPrice | Update AWS or Azure product pricing in one unified request | “Update the unified pricing for product prod-123” |
UpdateProductFulfillmentUrl | Set product fulfillment URL | “Set the fulfillment URL for prod-123” |
UpdateProductTargeting | Replace the list of buyer AWS accounts allowed to see and subscribe to a Limited-visibility AWS SaaS listing | “Set the buyer allowlist on our limited AWS listing to accounts 111122223333 and 444455556666” |
PublishProduct | Publish a product to marketplace | “Publish prod-123 to the marketplace” |
ListProductMeteringDimensions | List metering dimensions | “Show metering dimensions for prod-123” |
For an Azure product, CreateProduct and CreateOrUpdateDraftProduct take the product’s data in
info.azureProductResource. A request that carries it only in the older info.azureProduct is
refused with a 400.
Offer Management (15)
| Tool | Description | Example Prompt |
|---|---|---|
ListOffers | List offers | “List all my offers” |
QueryOffers | Query offers with filters | “Show active offers on AWS” |
GetOffer | Get offer details | “Get details for offer off-123” |
GetOfferByExternalId | Look up offer by external ID | “Find offer by external ID ext-456” |
CreateOffer | Create an offer | “Create a private offer for buyer xyz” |
CreateOrUpdateDraftOffer | Save a draft offer | “Save a draft offer” |
UpdateOfferMetaInfo | Update offer metadata | “Update metadata for off-123” |
UpdateOfferPrice | Add a new usage dimension to a released private offer | “Add a new pricing dimension to offer off-123” |
CancelOffer | Cancel an offer | “Cancel offer off-123” |
ExtendPrivateOfferExpiryDate | Extend offer expiry | “Extend the expiry date of off-123 by 30 days” |
SyncOffer | Sync offer from cloud partner | “Sync off-123 from AWS Marketplace” |
SendOfferNotifications | Notify offer contacts | “Send notification to contacts of off-123” |
GetOfferEula | Get offer EULA | “Show the EULA for off-123” |
GetOfferPdf | Export the offer’s current terms as a PDF and get a download link that expires after an hour; the EULA isn’t included | “Give me a PDF of offer off-123’s terms to share with the buyer’s procurement team” |
GetOfferResellerEula | Get reseller EULA | “Get the reseller EULA for off-123” |
Offer Sets (3)
| Tool | Description | Example Prompt |
|---|---|---|
ListOfferSets | List offer sets | “Show all offer sets” |
CreateOfferSet | Create an offer set | “Create a new offer set” |
GetOfferSet | Get offer set details | “Get offer set details” |
Entitlement Management (23)
| Tool | Description | Example Prompt |
|---|---|---|
ListEntitlements | List entitlements | “List all entitlements” |
QueryEntitlements | Query entitlements with filters | “Show entitlements expiring this month” |
GetEntitlement | Get entitlement details | “Get entitlement ent-123” |
CreateEntitlement | Create an entitlement | “Create an entitlement for buyer xyz” |
ApproveEntitlement | Approve a pending entitlement | “Approve entitlement ent-123” |
CancelEntitlement | Cancel an entitlement | “Cancel entitlement ent-123” |
ListEntitlementCancellationRequests | List cancellation requests for an entitlement | “Show pending cancellation requests for ent-123” |
WithdrawEntitlementCancellationRequest | Withdraw a cancellation request | “Withdraw the cancellation request for ent-123” |
ScheduleEntitlementCancellation | Schedule future cancellation | “Schedule cancellation for ent-123 at end of term” |
UnscheduleEntitlementCancellation | Remove scheduled cancellation | “Remove the scheduled cancellation for ent-123” |
GetEntitlementRenewalDraftOffer | Get the pending draft renewal offer for an AWS entitlement, if there is one | “Show the draft renewal offer for ent-123” |
AdjustEntitlementRenewalUplift | Reprice an AWS entitlement’s pending renewal offer to a different uplift within the agreement’s allowed range, saved as a draft or published to the buyer (publishing can’t be undone) | “Change the renewal uplift for ent-123 to 5% and keep it as a draft” |
OptOutEntitlementRenewal | Stop an AWS entitlement from auto-renewing by expiring its pending renewal offer | “Opt ent-123 out of auto-renewal” |
AddEntitlementCredit | Add credit to entitlement | “Add $500 credit to ent-123” |
ApplyAddonToEntitlement | Apply addon to entitlement | “Apply addon to ent-123” |
DivideEntitlementCommit | Divide entitlement commit | “Divide the commit for ent-123” |
UpdateEntitlementName | Rename an entitlement | “Rename entitlement ent-123” |
UpdateEntitlementMetaInfo | Update entitlement metadata | “Update metadata for ent-123” |
UpdateEntitlementPriceModel | Update pricing model | “Update pricing for ent-123” |
UpdateEntitlementSeat | Update Azure subscription seats | “Update seat count for Azure entitlement” |
ListEntitlementTerms | List entitlement terms | “Show terms for ent-123” |
GetEntitlementTerm | Get entitlement term details | “Get term details for ent-123” |
GetEntitlementPdf | Download agreement PDF | “Download the agreement PDF for ent-123” |
The three renewal tools act on AWS agreements with pre-authorized auto-renewal. See Pre-Authorized Auto-Renewal.
Buyer Management (10)
| Tool | Description | Example Prompt |
|---|---|---|
ListBuyers | List buyers | “List all buyers” |
QueryBuyers | Query buyers with filters | “Find buyers with company name Acme” |
GetBuyer | Get buyer details | “Get buyer details for buyer-123” |
CreateBuyer | Create a buyer | “Create a new buyer record” |
UpdateBuyer | Update a buyer | “Update buyer information for buyer-123” |
ListBuyerWallets | List buyer’s credit wallets | “Show wallets for buyer-123” |
CreateCreditWallet | Create a credit wallet | “Create a credit wallet for buyer-123” |
UpdateCreditWallet | Update a credit wallet | “Update credit wallet details” |
CloseCreditWallet | Close a credit wallet | “Close wallet for buyer-123” |
SetBuyerDefaultWallet | Set default wallet | “Set default wallet for buyer-123” |
Contact Management (9)
| Tool | Description | Example Prompt |
|---|---|---|
ListContacts | List contacts | “List all contacts” |
QueryContacts | Query contacts with filters | “Find contacts with @acme.com email” |
GetContact | Get contact details | “Get contact details for contact-123” |
CreateContact | Create a contact | “Create a new contact” |
BatchCreateContacts | Create multiple contacts | “Create contacts in batch” |
UpdateContact | Update a contact | “Update email for contact-123” |
UpdateContactTags | Update contact tags | “Add tags to contact-123” |
AddContactToBuyer | Link contact to buyer | “Link contact-123 to buyer-456” |
AddContactToOffer | Link contact to offer | “Link contact-123 to offer off-789” |
Metering & Usage (14)
| Tool | Description | Example Prompt |
|---|---|---|
ListBillableMetrics | List billable metrics | “Show all billable metrics” |
GetBillableMetric | Get billable metric details | “Get metric details for metric-123” |
CreateBillableMetric | Create a billable metric | “Create a new billable metric” |
UpdateBillableMetric | Update a billable metric | “Update metric definition” |
ReportUsageRecordGroup | Report usage | “Report usage for entitlement ent-123” |
BatchReportUsageRecordGroups | Report usage in batch | “Report usage in batch” |
BatchValidateUsageRecordGroups | Validate usage records | “Validate usage records before reporting” |
ListUsageRecordGroups | List usage records | “Find the usage records for invoice in_123” |
AggregateUsageRecordGroups | Aggregate usage data | “Aggregate usage data” |
RetryUsageRecordGroup | Retry failed usage report | “Retry failed usage reporting” |
ListUsageRecordReports | List usage reports | “Show usage reports” |
AggregateUsageRecordReports | Aggregate usage reports | “Aggregate usage reports” |
GetUsageMeteringConfigInfo | Get metering config | “Show metering configuration” |
UpdateUsageMeteringConfigInfo | Update metering config | “Update metering config” |
Reports (2)
| Tool | Description | Example Prompt |
|---|---|---|
ListUsageMeteringDailyRecords | List daily metering records | “Show daily metering records” |
ListDailyRevenueRecords | List daily revenue records for a date range, optionally for one marketplace, product, entitlement, buyer or currency | “Show our daily AWS revenue records for September 2026” |
Revenue (6)
| Tool | Description | Example Prompt |
|---|---|---|
QueryRevenueRecords | Query your revenue records a page at a time, with the total count — filter and sort them | “How many revenue records do we have from Azure?” |
AggregateRevenueRecords | Total your revenue for a period — invoice, collectable, disbursed and tax amounts per currency, with a breakdown by invoice date — for one marketplace, product, entitlement, buyer or currency, or all of them | “What was our total AWS revenue from July through September 2026?” |
ListRevenueAccountsReceivableInvoices | List your receivables invoices, newest issue date first, with each one’s status, amount paid and due, collectable amount, due date and aging bucket, and the Salesforce, HubSpot or Dynamics 365 opportunities it is linked to — filter by marketplace, buyer, entitlement, status (OPEN for the ones still owed), aging bucket or issue date | “Which AWS invoices are still open, and how overdue are they?” |
ListRevenueCashDisbursements | List your payout rows — the cash expected and received for each revenue record, payment or AWS billing event — with received and outstanding totals per marketplace or payment provider; filter by marketplace or payment provider (partner, such as AWS or STRIPE), status, currency, buyer, entitlement or date | “How much cash did we receive from Azure last quarter, and what is still outstanding?” |
ListRevenueCreditMemos | List your credit memos and recorded refunds — the rows of the Credit Memo report — filtered by marketplace or payment provider (partner) and issue date | “Which credit memos did we issue in October 2026?” |
ListRevenueRecordDetails | List the raw billing rows one marketplace reported: AWS billing events, Azure earnings, GCP charges and usage, Snowflake invoices or Oracle disbursements — for a product, entitlement or buyer, or for AWS one invoice | “Show the AWS billing events for invoice inv-123” |
Without a start date, AggregateRevenueRecords covers only the 30 days before its end date, which
defaults to today, so ask for the whole period you mean. ListRevenueRecordDetails also covers the
last 30 days by default, and its end date itself is not included.
The four list tools read the same figures as Invoices, Cash & Disbursements, the Credit Memo report in Financial Reports, and Raw Records. They return one page at a time — up to 500 invoices or payout rows, 200 credit memos, or 1,000 billing rows per call — rather than a whole export, so a large result takes several calls. All six tools only read, and need revenue read access. The Revenue workspace’s own dashboards and financial reports are not available as tools; use the Revenue workspace in the Fours console for those, or have your assistant query and chart your revenue with the Analytics tools.
Analytics (21)
Ask questions of your organization’s analytics data and get the answer back as rows, and read, build and change the organization’s saved charts and dashboards. The data is grouped into datasets: revenue, AWS billing events, offers, entitlements, products, buyers, co-sell referrals and leads. An assistant starts with ListAnalyticsDatasets, reads the fields of the datasets a question needs with GetAnalyticsDataset and the query language with GetAnalyticsQueryGrammar, checks its query with DescribeAnalyticsQuery, and then runs it with QueryAnalytics. A query is a structured document in that language, not SQL, and Fours checks it before it reads any data.
Datasets and queries
| Tool | Description | Example Prompt |
|---|---|---|
ListAnalyticsDatasets | List the datasets you can query, each with its measures and segments, the datasets it relates to, and how much data your organization has in it: its row count and its first and last day, or that it has no rows yet. When that can’t be read at the moment, the dataset is listed without it | “What analytics data do we have, and how far back does it go?” |
GetAnalyticsDataset | Get one dataset’s fields, measures, segments and relationships, the names a query over it may use | “Which fields can our revenue be broken down by?” |
GetAnalyticsQueryGrammar | Get the analytics query language, with worked example queries over the datasets you can query | “Show me how to write an analytics query for monthly revenue” |
DescribeAnalyticsQuery | Check a query, and a chart config if you give one, without reading any data: the result’s columns and the chart types it fits, or every problem found, often with a fix | “Check this query before you run it” |
QueryAnalytics | Run a query against your organization’s analytics data and return its rows | “What was our revenue on each marketplace, month by month, this year?” |
Saved charts
| Tool | Description | Example Prompt |
|---|---|---|
ListAnalyticsCharts | List your organization’s saved charts, newest first | “Which saved charts do we have?” |
GetAnalyticsChart | Get one saved chart’s title, description, version, query and chart config | “Show me the query behind our monthly revenue chart” |
GetAnalyticsChartData | Run a saved chart’s query and return its result | “What does our monthly revenue chart show right now?” |
CreateAnalyticsChart | Save a chart: a query and, if you give one, the config that draws it. Both are checked first, and a chart that doesn’t pass is refused with the problems found | “Save a chart of our monthly revenue by marketplace” |
UpdateAnalyticsChart | Change a saved chart’s title, description, query or chart config | “Rename our monthly revenue chart to Monthly marketplace revenue” |
Dashboards
| Tool | Description | Example Prompt |
|---|---|---|
ListAnalyticsDashboards | List your organization’s dashboards, newest first, each with its document: its blocks, filters and interactions | “Which analytics dashboards do we have?” |
GetAnalyticsDashboard | Get one dashboard with the saved charts on it that you can read, and which charts each filter reaches | “Show me what’s on our revenue dashboard” |
GetAnalyticsDashboardData | Run every chart on a dashboard with its filters set as a viewer would set them, and return each chart’s result | “What does our revenue dashboard show for the last 6 months?” |
GetAnalyticsDashboardBlockData | Run one chart on a dashboard with the same filters | “Show just the top-products chart from our revenue dashboard” |
GetAnalyticsDashboardFilterOptions | List the choices one of a dashboard’s select filters offers under the other filters, most rows first, up to 200 | “Which products can I filter our revenue dashboard by?” |
GetAnalyticsDashboardBlockDetail | List the records behind a chart’s numbers, a page at a time, on a dashboard that allows it | “Show me the records behind March on our revenue chart” |
CheckAnalyticsDashboard | Check a dashboard document without saving it, and return every problem found, with where it is and a fix | “Check this dashboard before you save it” |
CreateAnalyticsDashboard | Create a dashboard from its document: its layout of blocks, the filters a viewer sets, and its interactions | “Build a dashboard of our revenue by month and our offers by status” |
UpdateAnalyticsDashboard | Replace a dashboard’s whole document | “Add a marketplace filter to our revenue dashboard” |
UpdateAnalyticsDashboardLayout | Move, resize, rename or remove a dashboard’s blocks without changing any chart | “Move the revenue trend to the top of our revenue dashboard” |
AddAnalyticsDashboardChart | Add a saved chart to a dashboard as a full-width block | “Add our monthly revenue chart to the revenue dashboard” |
Every Analytics tool reads with your own permissions. Each dataset needs read access to its data, so
revenue and AWS billing events need revenue read access, offers need offer read access, and so on. A
dataset you can’t read isn’t listed, a saved chart over it is left out of ListAnalyticsCharts and
answers as not found, and on a dashboard its block keeps its title but shows no data.
Saved charts and dashboards belong to your organization. Creating or changing one needs the
Admin or Editor role; a Viewer or a
custom role can read them but not
change them. Deleting one is a DELETE tool, which an assistant you connect yourself doesn’t get
by default (see the note at the top of this page).
Each chart and dashboard has a version. An update names the version the assistant last read, and
one that someone changed since is refused with VERSION_CONFLICT, so the assistant reads it again
before it retries.
Queries read the analytics data Fours publishes for your organization, not your live records.
ListAnalyticsDatasets gives each dataset’s row count and its first and last day, unless it couldn’t
read them at the moment, so the assistant can check how far the data goes before it answers about a
period. DescribeAnalyticsQuery, QueryAnalytics, CheckAnalyticsDashboard and
GetAnalyticsDashboardBlockDetail are sent as POST requests but only read, so they are marked
read-only like the tools that get or list.
A query that would read too much data is refused with COST_TOO_HIGH: narrow its time range or add
a filter. Fours runs only so many analytics queries at once for your organization, so in a burst a
query can be refused as BUSY, and one that runs past its time limit fails with TIMEOUT; try
again in a moment. When the analytics data can’t be reached, a call answers ANALYTICS_UNAVAILABLE;
try again later. GetAnalyticsDashboardBlockDetail returns records that can name buyers and amounts,
so it works only on a dashboard whose interactions.detail setting is on.
Co-Sell (35)
Run the full co-sell referral lifecycle from chat — create, list, update status / stage, sync, and pull dashboard insights — work the leads AWS Partner Central sends you, and fill in the deal-registration drafts waiting for your team’s review. A referral’s partner says who it is shared with: AWS, AZURE and GCP share the opportunity with that cloud provider; SUGER shares it with another company you partner with through Fours. The two kinds have their own tools. The referral tools such as CreateCosellReferral take AWS, AZURE or GCP, and the …SugerCosellReferral tools take SUGER; each refuses the other kind of referral and names the tool to use instead. ListAllCosellReferrals lists both kinds.
| Tool | Description | Example Prompt |
|---|---|---|
ListCosellReferrals | List AWS, Azure and GCP co-sell referrals (inbound + outbound). Filter by partner, status, stage, time range or text, or by an AWS referral’s engagement score (High, Medium, Low) or minimum quality score | “List my AWS referrals in Pending Acceptance status from last week” |
ListAllCosellReferrals | List co-sell referrals with every partner — AWS, Azure, GCP and partner companies through Fours — in one list; deal-registration drafts are left out | “List every co-sell we share with partner companies through Fours” |
GetCosellReferral | Get full details of a single AWS, Azure or GCP referral by ID, including an AWS referral’s engagement and quality scores once AWS has scored it | “Show me referral ref-abc123” |
GetSugerCosellReferral | Get full details of a referral shared with a partner company through Fours, including its commission terms and their computed preview | “Show me the co-sell we shared with Contoso” |
CreateCosellReferral | Create an outbound co-sell referral to a cloud provider (AWS / AZURE / GCP) | “Create an AWS co-sell referral for Acme Corp, expected close date 2026-09-30” |
CreateSugerCosellReferral | Share a deal you sourced with a partner company through Fours; the partner gets their own copy to accept or decline | “Share the Acme Corp deal with Contoso” |
RegisterCosellOnBehalf | File a Fours partner co-sell on a partner’s behalf — for partners who send deals by email and expect you to register them; it is active at once | “Register the deal Contoso emailed us on their behalf” |
UpdateCosellReferral | Update an AWS, Azure or GCP referral’s fields, status, or stage | “Change the expected close date on AWS referral ref-abc123 to 2026-12-15” |
UpdateSugerCosellReferral | Update a referral shared with a partner company through Fours — and, for one a partner shared with you, accept or decline it | “Accept the referral Contoso shared with us” |
ProposeCosellReferralUpdate | AWS referrals only: stage a proposed change for a person to approve or reject on the referral page, or record an outcome that needs a person — either way without changing the referral | “Propose an update to AWS referral ref-abc123 for my team to approve” |
BatchCreateCosellReferrals | Create multiple AWS, Azure or GCP referrals in one call (recommended ≤ 20) | “Share these 10 opportunities to AWS as referrals” |
BatchCreateSugerCosellReferrals | Share up to 100 deals with one partner company through Fours in one upload; they are created in the background | “Share these 30 deals with Contoso” |
BatchPreviewCosellReferrals | Preview the AWS, Azure or GCP referrals that would be created from CRM records, before creating them | “Preview referrals for these 5 Salesforce opportunities” |
BatchPreviewSugerCosellReferrals | Preview up to 20 CRM records as referrals with a partner company through Fours, before sharing them; creates nothing | “Preview these 5 Salesforce opportunities as co-sells with Contoso” |
ValidateReferral | Dry-run validate a referral against partner schema before creating | “Validate this referral before submitting to AWS” |
PredictReferralQualityScore | Predict the AWS opportunity quality score for a referral | “Score this AWS opportunity before I submit it” |
SyncSingleReferral | Sync a single referral with the cloud partner (AWS / Azure / GCP) | “Sync referral ref-abc123 to AWS” |
SyncSugerCosellReferral | Bring a referral shared with a partner company through Fours up to date with its linked Salesforce or HubSpot record | “Refresh the Contoso co-sell from its Salesforce opportunity” |
AzureMicrosoftSolutionLookup | Search Microsoft’s first-party catalog (Azure, Microsoft 365, Dynamics) and return each match’s solution id | “Find the Microsoft solution id for Azure Kubernetes Service” |
AzureThirdPartySolutionLookup | Search solutions published by companies other than Microsoft — including your own listings — and return their ids | “Find the Partner Center solution id for our own listing” |
AzureInvitePartnerCollaboration | Invite another partner to collaborate on an Azure referral (Azure only) | “Invite partner X to collaborate on this Azure referral” |
GetCosellDashboard | Co-sell insights: pipeline KPIs, outstanding actions, activity logs | “Show my co-sell pipeline for the last 30 days” |
GetPartnerContacts | List known partner contacts for a buyer company (by email domain) | “Who at AWS have we worked with for acme.com before?” |
SearchPartnerConnections | Search the org’s connected AWS partners by name or AWS account ID. The tool’s own description mentions only the name, so ask for an account ID search explicitly | “Find AWS partner connections matching ‘Snowflake’” |
UpdateCosellPartner | Seller-only: update one partner’s copy of a SUGER co-sell — revenue-share terms, attribution role and deal-value visibility (each before Close Won), and collaboration fields | “Hide the deal value from Contoso on referral ref-abc123” |
ProposeCommissionUpdate | Seller-only: propose new commission terms to a partner after Close Won; the partner must approve | “Propose a 12% commission for Contoso on referral ref-abc123” |
UpdateCommissionLifecycle | Move a SUGER co-sell’s commission to its next state once the deal is Won — approve it, mark payment sent, confirm receipt, or claw it back | “Mark Contoso’s commission on referral ref-abc123 as payment sent” |
ListDealRegistrationDrafts | List the deal-registration drafts awaiting your team’s review, newest first | “Which deal registrations are waiting for review?” |
GetDealRegistrationDraft | Get one draft and the facts it is still missing | “What is the Acme Corp draft still missing?” |
CreateDealRegistrationDraft | Record a deal a partner raised as a draft for your team to review — it registers nothing | “Log the deal Contoso raised in this Slack thread for review” |
UpdateDealRegistrationDraft | Fill in or correct a draft before your team confirms it; customer info and deal details are replaced whole | “Add a 50,000 USD deal value to the Acme Corp draft” |
ListLeads | List AWS Partner Central leads, filtered by invitation status (PENDING, ACCEPTED, REJECTED, EXPIRED), qualification status or status | “Which AWS lead invitations haven’t we accepted yet?” |
GetLead | Get the full record for one lead: the invitation and, once accepted, the customer and the contact AWS supplied, interactions, qualification status, and any link to the opportunity it became | “Show me lead lead-123” |
AcceptLead | Accept a lead invitation that is still PENDING, recording the acceptance with AWS | “Accept the pending AWS lead from Acme Corp” |
GetReferralFundingRecommendation | AWS referrals only: ask AWS Partner Central which funding programs the referral qualifies for, and list the other funding cards you can ask about | “Which AWS funding programs does referral ref-abc123 qualify for?” |
The three commission tools apply only to SUGER co-sells. UpdateCosellPartner changes a
partner’s revenue-share terms only before Close Won; after it, ProposeCommissionUpdate proposes
new terms and UpdateCommissionLifecycle advances the commission. See
Commission states for the allowed state changes.
If the partner’s copy is saved or removed while an UpdateCosellPartner call is in flight, the call
is refused with 409 and changes nothing. Have the assistant read the co-sell again and send the
change again. See Troubleshooting.
The four deal-registration draft tools work the review queue described in
Track and Respond to Deals. None of them registers a deal or
shares anything with a partner: a person on your team confirms or discards each draft in the Fours
console. Confirming or discarding a draft is not a tool. A draft is a SUGER co-sell in DRAFT status. Drafts don’t appear in ListAllCosellReferrals
or the co-sell dashboard until they are confirmed.
UpdateDealRegistrationDraft replaces a draft’s customer info and deal details as a whole, so the
assistant reads the draft first and sends every field it wants to keep.
CreateDealRegistrationDraft needs only the deal name, or the customer’s company name, to start a
draft. Each draft comes back with missingFields: what the partner can still be asked for. That can
be the customer’s website, industry and country, the deal value and currency, the target close date,
or a business-problem description of at least 20 characters. An empty list means there is nothing
left to ask the partner. It does not mean the draft is ready: your team still sets the deal type,
delivery model and collaboration context in the console.
An Azure referral needs at least one entry under details.requirements.solutions, and that entry’s
id is a Microsoft catalog identifier that cannot be guessed or composed. Use
AzureMicrosoftSolutionLookup for Microsoft’s own products and AzureThirdPartySolutionLookup for
everything published by someone else (including your own listings), then pass the id you picked to
CreateCosellReferral. Both read the catalog through your organization’s Microsoft Partner Center
connection and change nothing, so an organization with no Azure connection cannot use them.
ValidateReferral also returns duplicateOpenReferrals — referrals already in your organization,
for the same partner, whose title matches the one being validated and whose status is not yet
concluded. It is a warning, not a block: it does not change valid, and two referrals can
legitimately share a title (a renewal, or a phased project). Your assistant should tell you which
referrals matched and ask before it goes ahead.
ValidateReferral covers AWS, GCP and Azure only. Called with partner=SUGER, it returns an error.
For a Fours partner-to-partner referral, skip validation and call CreateSugerCosellReferral directly.
ListLeads, GetLead and AcceptLead work the leads AWS Partner Central sends you — see
AWS Partner Central Leads. AcceptLead accepts an invitation only while it
is PENDING, and starts the sync that records the acceptance with AWS. Any other invitation status
is refused with a 400 that names it, so an assistant can tell a lead that is already ACCEPTED
from a failure. It doesn’t qualify the lead, convert it into an opportunity, or send anything to the
customer. Rejecting, qualifying, editing and converting a lead aren’t available as tools; do those
in the Fours console.
GetReferralFundingRecommendation needs your organization’s AWS co-sell connection through the
AWS Partner Central API, and an AWS referral that has
already synced to AWS Partner Central. Otherwise the call is refused with an error that says which.
It asks AWS Partner Central’s agent, so the amounts in its answer are estimates, not approvals.
The answer also lists, in availableCards, the other funding cards the deal qualifies for. They are
listed, not run: ask for one by passing its triggerId. When AWS takes longer than about 25 seconds,
the tool returns pending with no content. Ask again about a minute later: that call returns the
answer, or the error if AWS failed. Fours keeps each answer for 48 hours, so asking for the same card
on the same referral again in that time doesn’t wait on AWS.
Proposing a referral update
ProposeCosellReferralUpdate works on AWS referrals only. Any other referral is reported as not
found. It stages a change for a person on your team to approve or reject, and never changes the
referral itself. A new proposal replaces one that is still waiting. Approving or rejecting a proposal
is not a tool, so an assistant cannot approve its own proposal.
The proposal is refused with a 400, and nothing is stored, when:
- the referral isn’t open. Its status must be
ACTIVE,IN_REVIEW,ACTION_REQUIREDorUPDATE_FAILED, at a stage that doesn’t end the deal. A change that would close it, for example by moving it toLaunchedorClosed Lost, is refused too. - the change would blank a field that has a value.
- the change sets the target close date or the software revenue start or end date without naming,
in
fieldSources, where that exact date came from (for example, the Salesforce opportunity’s Close Date). When no source names the exact day, the assistant should leave that date out and list it inblockedFieldswith the reason. - the change sets a target close date that isn’t after today. Fours checks this again when a person approves the proposal, so a proposal whose close date has passed by then can’t be approved.
- the new text names another cloud, or contains an email address, a phone number, or pricing or discount terms.
- the referral is linked to a Salesforce opportunity that someone edited in the last 24 hours, or Fours can’t read that opportunity to check. Edits by Fours’ own Salesforce sync don’t count.
- the referral has no linked Salesforce opportunity but is linked to a HubSpot deal that a HubSpot user edited in the last 24 hours, or Fours can’t read that deal to check. Edits by the user Fours’ HubSpot integration writes as don’t count. Neither do changes that name no user, such as a workflow’s or an app’s. If HubSpot is no longer connected to Fours, there is nothing to check.
Two proposals are not stored but not refused either. One is a proposal whose every value already
matches the referral. The other is a proposal whose predicted AWS quality score (predictedScore)
is lower than the referral’s current score. The response’s note says which, for example
no change: every proposed value matches the referral. A proposal already waiting stays as it was.
For an AWS MPOPP funding request, the same tool accepts kind: "fund-request",
statusCode: "UPDATE_PROPOSED", and the application in fundRequest.awsBenefitApplication:
- Name resources by ARN.
AssociatedResourcesnames the referral’s opportunity by its ARN (info.aceOpportunityV2.ArnfromGetCosellReferral) and the funding wallet by its allocation ARN (arnfromListFundingBenefits). Fours refuses a bare opportunity ID with a400. Name the alliance contact inPartnerContacts. - Fours fills in the deal. From the private offer the opportunity links, the opportunity and the
wallet, Fours sets the buyer’s AWS account, the offer and product, the total contract value, the
credit, the program fields, the customer’s location, and the request’s name, description and
summary, replacing what the assistant sent. The request is refused with a
400when that offer isn’t in Fours or names no buyer account. - Over $1,000,000, a person confirms the credit. On a deal whose total contract value is over $1,000,000, the person approving the request confirms the credit amount.
A person approves or rejects the request on the referral page; approving files the application as
that person. It supports MPOPP:Activate and MPOPP:Grow and refuses a request when the
opportunity already has an application, including a draft. A funding request waits alongside a
referral-edit proposal and replaces only an earlier funding request. The referral-edit restrictions
above do not apply to it; the agent’s three-tries-per-skill limit still does. See
Ask about funding for how Fours sizes the credit.
Commission states
UpdateCommissionLifecycle advances a commission when you name the target state you want. The
action is worked out from the current state and the target. Only these pairs are allowed:
| From | Target state | What it means |
|---|---|---|
PENDING | APPROVED | The commission terms are agreed. |
APPROVED | PAYMENT_SENT | Payment has been sent to the partner. |
PAYMENT_SENT | CONFIRMED | The partner confirmed receipt. |
PAYMENT_SENT | APPROVED | The partner rejected the payment, sending it back for another attempt. |
CONFIRMED | CLAWED_BACK | The commission has been reversed after receipt was confirmed. |
Any other pair is refused with INVALID_TRANSITION.
The commission lives on the payee (reseller) copy, which the server finds for you. You always pass
your own referralId. A Seller must also send partnerOrganizationId to say whose commission is
being acted on. A partner acting on its own commission leaves it out.
To change the commission terms rather than advance the state, use ProposeCommissionUpdate. Only a
Seller can call it, and the partner must approve. The partner approves through
UpdateCommissionLifecycle.
A Reseller Margin set as a discount off list price is terms only. Nothing is paid out, so Fours
tracks no commission for it and UpdateCommissionLifecycle has nothing to advance. For the same
reason, ProposeCommissionUpdate refuses to replace a commission that is already being tracked with
a discount off list price.
Funding (8)
| Tool | Description | Example Prompt |
|---|---|---|
ListFundingBenefits | List your organization’s AWS benefit wallets — each one’s program, status, currency, start and expiry, allocation ARN, and the amounts its type carries, such as allocated, used and remaining | “How much MDF do we have left?” |
ListFundingApplications | List your organization’s funding applications, a page at a time; deleted applications are left out | “Which funding applications do we have open?” |
GetFundingApplication | Get one funding application by its ID | “Show the details of our latest funding application” |
PreviewFundingApplicationFieldMapping | Prefill an AWS benefit application from one Salesforce opportunity or HubSpot deal, using the field mapping you configured for that program and funding type; saves nothing | “Prefill a POC cash application from opportunity 006Hn00000Abc” |
ValidateFundingApplicationPayload | Check a benefit application against the checks Fours runs before an application goes to AWS Partner Central, and return the field errors it finds; saves and sends nothing | “Is this MDF application ready to submit?” |
CreateFundingApplicationDraft | Save an AWS funding application as a draft for a person to review — not sent to AWS. Missing fields don’t block the save; they come back in errors | “Save a draft MDF application for the Globex opportunity” |
SubmitFundingApplication | Send a reviewed draft to AWS Partner Central. Call it only after a person approved the draft: it records that approval and starts the submission | “Submit the approved Globex MDF draft” |
CreateFundingApplication | Create an AWS funding application and send it in one call, or resubmit one AWS sent back for changes — for when approval happened before the call | “Resubmit funding application fa-123 with the corrected budget” |
Wallet balances are balances, not approvals. Spending a benefit on a deal is a funding application,
and the assistant can now prepare one: preview it from a CRM opportunity, validate it against
Fours’ submission checks, save it as a draft, and — once a person has approved the draft — submit it.
Preview and validate only read. Preview reads the opportunity from your CRM when it runs, and when your
field mapping has AI-generated fields it calls a language model and records AI usage for your
organization, so such a preview has a cost. The draft, submit and create tools write, and submit and create send
the application to AWS Partner Central, so an assistant that confirms writes will ask you first.
A draft that still has missing fields can’t be submitted: the call answers with the field errors and
the draft stays as it was. When CreateFundingApplication refuses an application with a 400, the
answer lists each field to fix and why. See AWS Funding.
Partner Relationship Management (40)
Manage the partner companies you work with, the invitations that bring them onboard, and the program you run with them: journeys, tasks, training, agreements, events, shared files and the program’s settings. Start with ListPrmPartnerships. A row’s id is the partnershipId the other partner tools need, and its partnerOrgId is a different value, the partner’s own Fours organization, which ListPartnerFiles and GetPartnerTrainingProgress ask for by that name. Get the invitationId the respond / withdraw / resend tools need from ListPrmInvitations, and journey-template and tier ids from GetPrmConfig; a task, agreement, event, course or file id comes from that item’s list tool. To invite a company you don’t have a partnership with yet, call CreatePrmInvitation with newPartner instead of a partnershipId. ListPartnerFiles with linkable=true returns the files you can link from an invitation email; pass a file’s id to CreatePrmInvitation or GeneratePrmInvitationEmail. For the permission each PRM tool needs and worked examples, see Partner Management with AI (MCP).
Partners and contacts
| Tool | Description | Example Prompt |
|---|---|---|
ListPrmPartnerships | List the partner companies this organization has a relationship with | “Who are our partners?” |
GetPrmPartnership | Get the full record for one partner relationship, including the partner-portal view | “Show me everything about our partnership with Contoso” |
ListPrmOrgPartnerContacts | List the people at your partners — the contacts Fours stores: those added in the hub, from deal registrations, the partners’ portal users and open portal invitations — grouped by partner or one row per person, filterable by q, partnershipIds, role, source and syncStatus. With one partnershipIds value and include=crm, it also reads that partnership’s linked CRM Account live and lists its contacts — the list the partner record’s Relationship Hub shows | “Who should I contact at Contoso?” |
ListPrmPartnerSuggestedContacts | List the people company enrichment suggests at one partner company — suggestions, not the partnership’s contacts | “Who else could we talk to at Contoso?” |
CreatePrmPartnerContact | Add a person to a partner’s Relationship Hub contact list (first name, last name and work email required); with createInCrm, also create them on the partnership’s linked Salesforce Account | “Add Dana Lee, Contoso’s new alliances lead, to their contacts” |
UpdatePrmPartnerContact | Edit a person on a partner’s Relationship Hub contact list; with syncToCrm, push their name and title to the linked Salesforce Account | “Change Dana Lee’s title at Contoso to VP Alliances and sync it to Salesforce” |
GetPrmPartnerCommissionLedger | Get one partner’s commission ledger — per closed-won deal, plus totals per currency | “What has Contoso earned from us this year?” |
UpdatePrmPartnership | Update the editable fields of one partner relationship (manager, status, types, profile, champion) | “Assign Dana as the partner manager for Contoso” |
Invitations
| Tool | Description | Example Prompt |
|---|---|---|
ListPrmInvitations | List every partner invitation this organization sent or received, or with partnershipId one partner’s invitation history; search finds a partner application by its company, submitter name, email or website | “Which partner invitations are still outstanding?” |
CreatePrmInvitation | Send a partner invitation and try to email it to a named recipient: with partnershipId, to another person at an existing partner; with newPartner, to a company that isn’t a partner yet. With cancelInvitationId, edit and resend an invitation we sent | “Invite dana@contoso.com to our Contoso partnership” |
RespondToPrmInvitation | Accept or decline an invitation another company sent to us, or an application to our partner program, with the required decision. Accepting establishes the partnership; declining creates none, and an optional reason, up to 4,000 characters, is kept on the invitation and included in the decline email they receive | “Decline the partnership invitation from Contoso and tell them we aren’t adding partners in their region this quarter” |
CancelPrmInvitation | Withdraw an invitation we sent, invalidating its accept link, and the in-app copy a partner company already on Fours received | “Cancel the invitation we sent to dana@contoso.com” |
ResendPrmInvitation | Extend the accept-by date of a pending or expired invitation we sent, and try to re-send the original email | “Resend our invitation to dana@contoso.com” |
GeneratePrmInvitationEmail | Draft the subject and body for a partnership invitation email — text only, sends nothing | “Draft an invitation email for Contoso” |
Journeys
| Tool | Description | Example Prompt |
|---|---|---|
ListJourneyAssignments | List the onboarding and enablement journeys assigned to your partners — each with its steps, their due dates and its progress — plus organization-wide totals of active, completed and stalled journeys. The list and its totals also include journeys another company assigned to you. With assignmentId, it returns that one journey | “Which partners are stuck in onboarding?” |
AssignJourney | Assign an active journey template to a partnership where you are the seller: it creates the steps’ tasks and agreements, gives the partner access to the steps’ courses, and emails you and the partner’s champion | “Assign our Onboarding journey to Contoso” |
TransitionJourneyStep | Mark a journey step done, or reopen it; a step that counts itself is refused with 409 JOURNEY_STEP_AUTOMATIC | “Mark the kickoff step done on Contoso’s onboarding journey” |
Tasks
| Tool | Description | Example Prompt |
|---|---|---|
ListPartnershipTasks | List the tasks you track with your partners — status, priority, due date, assignees and direction — filtered by partnership, status or assignee; partners’ marketing points requests are listed only with tab=marketingPoints | “Which partner tasks are blocked?” |
GetPartnershipTask | Get one task with its subtasks, resources and current version | “Show the Contoso co-marketing task” |
ListPartnershipTaskTemplates | List your reusable partnership task templates | “Which partner task templates do we have?” |
CreatePartnershipTask | Create a task on one partnership; it starts OPEN | “Create a task for Contoso to review the launch checklist by Friday” |
UpdatePartnershipTask | Change a task’s title, description, priority, due date, assignees, tags, subtasks or resources | “Move the Contoso launch-checklist task to next Friday” |
TransitionPartnershipTask | Move a task to OPEN, IN_PROGRESS, BLOCKED or COMPLETED | “Mark the Contoso launch-checklist task complete” |
Training
| Tool | Description | Example Prompt |
|---|---|---|
ListCourses | List the training courses you authored, or with tab=from_partners the published courses partners shared with you | “List our partner training courses” |
GetCourse | Get one course with its modules, lessons and settings | “Show the modules in our partner sales certification” |
ListCourseEnrollments | List the enrollments in one course (courseId), with each learner’s organization, status and progress, or with mine=true your own enrollments | “Who is enrolled in our partner sales certification?” |
ListIssuedCertificates | List earned certificates: by default the ones your own users hold from courses partners shared with you, or with courseId the certified learners of one of your own courses | “Which partner certifications does our team hold?” |
GetPartnerTrainingProgress | Tally your published courses across every partner, by course and by partner, least complete first; with partnerOrgId, one partner’s numbers, including the courses nobody there has started | “Which partners are furthest behind on training?” |
Agreements
| Tool | Description | Example Prompt |
|---|---|---|
ListPartnerAgreements | List partner agreements, newest first, with their type, status and dates | “Which partner agreements are still awaiting signature?” |
UpdatePartnerAgreement | Change an agreement’s status, name, type, effective date or expiry date | “Mark the Contoso NDA as fully executed” |
Events
| Tool | Description | Example Prompt |
|---|---|---|
ListPartnerEvents | List the partner events you run and those shared with you by companies whose partner program you belong to, past events included | “Which partner events do we have coming up?” |
GetPartnerEvent | Get one event’s schedule, location or meeting link, sharing and RSVP settings | “Show the details of our Q1 partner webinar” |
ListPartnerEventRsvps | List who responded to one of your events, and from which organization | “Who has RSVP’d to our Q1 partner webinar?” |
CreatePartnerEvent | Create a webinar, training, in-person or general event and share it with all partners, specific partners or a tier | “Create a partner webinar on March 12 at 10am Eastern for our Gold tier” |
UpdatePartnerEvent | Change, publish or cancel one of your events | “Cancel our Q1 partner webinar” |
Files
| Tool | Description | Example Prompt |
|---|---|---|
ListPartnerFiles | List your partner file library, with direction the files you shared with or received from one partner, or with linkable=true the files an invitation email can link — files shared with all partners that can be downloaded | “Which files has Contoso shared with us?” |
GetPartnerFile | Get one file with a link to it | “Give me a link to Contoso’s co-marketing one-pager” |
Program
| Tool | Description | Example Prompt |
|---|---|---|
GetPrmDashboard | Get one section of the partner program dashboard: the headline figures and what needs attention, the per-country footprint, the Money & Admin queue, or a per-partner table — the partner pipeline (each partner’s Fours co-sell deals created in a period, by default this quarter: open, won and lost, money per currency and win rate) or portal adoption (portal users, logins, deal registrations and completed courses) | “What needs attention in our partner program this week?” |
GetPrmConfig | Get your partner program settings, including journey templates, tiers, partner sign-up forms, file-sharing defaults, the fiscal year start, tier renewal and Salesforce tier sync, the marketing activities partners earn points for, and which PRM modules are hidden or renamed | “Which journey templates can we assign?” |
UpdatePrmConfig | Change your partner program settings: sign-up forms, file sharing, profile, commission settings, the deal registration form, tiers and the default tier, journey templates, the fiscal year start, tier renewal and Salesforce tier sync, and the marketing activities. An organization admin can also turn Training or Commissions on or off and hide or rename a module. Send only the settings to change; a list is replaced whole | “Turn on yearly tier renewal for our partner program” |
An invitation is saved — or, for a resend, given a new accept-by date — even when its email fails,
so delivery is reported separately. ResendPrmInvitation returns emailSent; when it is false,
no email went out and emailError says why. CreatePrmInvitation records the outcome on the
invitation it returns, as info.outbound.emailDelivery.status (SENT or FAILED, with a
reason when it failed). Your assistant should check these fields and never report a failed
delivery as a plain success. CreatePrmInvitation also refuses a recipient who already has an
invitation in Sent state, so a retry never sends a second email. The one exception is the invitation
it replaces through cancelInvitationId.
To edit and resend an invitation we sent, for a wrong recipient or a changed message, the assistant
finds it with ListPrmInvitations and passes its id as cancelInvitationId to
CreatePrmInvitation, with the same partnershipId and the whole new message. If the old
invitation is still in Sent state, it is cancelled in the same step and its link stops working; one
already Expired or Cancelled is left as it is; one already Accepted or Declined refuses the
call with a 409, and nothing is sent. If the new invitation can’t be created, the old one isn’t
cancelled. If its email then fails, the new invitation still exists and the old one stays cancelled,
so ResendPrmInvitation sends the new one again. Editing and resending also needs partners.edit.
See Edit and resend an invitation.
A partner application, a request that reached you through your partner sign-up form, never
expires: you can accept or decline it however long ago it arrived, and an older one may still show
as Expired in ListPrmInvitations. An invitation another company sends you from its own Fours
organization still expires.
To set a partner’s champion with UpdatePrmPartnership, send info.partnerChampionContact with a
contactId as well as the contact’s name, email and title. A champion without a contactId is
refused with a 400. Leave the field out to keep the current champion, or send {"contactId": ""}
alone to clear it.
UpdatePrmConfig merges each top-level setting on its own, so a call that sends one keeps
the others. A list, such as the tiers or the journey templates, is replaced whole: the assistant
reads the settings with GetPrmConfig first and sends every row to keep, changed or
not. Turning Training or Commissions on or off, and hiding or renaming a module, is for an
organization admin only; a change to either from anyone else is refused and nothing in the call is
saved. TransitionJourneyStep can’t tick a step that counts itself (Deals, Marketing points,
or Earn certification with a number of people); see
Steps That Count Themselves. The
per-partner tables in GetPrmDashboard are described in
Partner Pipeline and Portal Adoption.
The list tools in this group that take limit and offset return 10 rows per call unless limit
is set, up to 100, or 200 for ListJourneyAssignments, ListPartnershipTasks and
ListPartnershipTaskTemplates. A limit above that cap, up to 1,000, returns only the capped
number of rows and sends offset to the wrong page, and one over 1,000 is refused. So the assistant
should send limit on every call, with offset a multiple of it (0, limit, twice limit, …),
until it has total_count rows.
GetPartnerFile’s link lasts one hour, except for a file that belongs to another organization and
has downloads turned off. Such a file is meant to be viewed, not saved: a PDF or image gets a link
that opens it in the browser for 5 minutes, an mp4 video the same for one hour, and any other type
no link. Don’t pass a view-only link on.
GetPartnerTrainingProgress only reads, and needs partners.read. It returns counts, not rates, so
ask for the numbers behind any percentage. For one partner it takes the partner’s partnerOrgId, not
the partnership id; a wrong id is not refused but returns zeros for every course.
Support Tickets (11)
| Tool | Description | Example Prompt |
|---|---|---|
ListSupportTickets | List support tickets | “Show all open support tickets” |
GetSupportTicket | Get ticket details | “Get details for ticket-123” |
CreateSupportTicket | Create a support ticket | “Create a ticket for a billing issue” |
UpdateSupportTicket | Update a support ticket | “Set ticket-123 priority to high” |
CloseSupportTicket | Close a ticket | “Close ticket-123” |
ReopenSupportTicket | Reopen a ticket | “Reopen ticket-123” |
CreateSupportTicketComment | Add a comment to a ticket | “Add a comment to ticket-123” |
CreateSupportTicketAttachment | Attach up to 10 files to a ticket, up to 10 MiB each: images show in the comment, and other files, such as a PDF, CSV or Office document, are linked for download | — |
CreateOrgSupportAttachment | Upload an image for a ticket you haven’t created yet, and get back the URL to reference it by in the ticket description | — |
DownloadSupportTicketAttachment | Download an attachment from a support ticket | “Download the attachment on ticket-123” |
DownloadSupportTicketFile | Download a file Fours support attached to a ticket, such as a PDF, spreadsheet or archive | “Download the PDF Fours support attached to ticket-123” |
Notifications (6)
| Tool | Description | Example Prompt |
|---|---|---|
ListNotificationEvents | List notification events | “Show recent notification events” |
ListNotificationEventsByEntity | List notifications for an entity | “Show notifications for offer off-123” |
ListNotificationMessages | List notification messages | “List notification messages” |
GetNotificationMessage | Get notification message details | “Get notification message details” |
GetNotificationConfigInfo | Get organization notification config | “Show my notification settings” |
UpdateNotificationConfigInfo | Update organization notification config | “Update my notification settings” |
Operations (3)
| Tool | Description | Example Prompt |
|---|---|---|
ListOperationsV2 | List operations with filters | “Show recent operations” |
GetOperationV2 | Get operation details | “Get details for operation op-123” |
ListOperationHistoryV2 | Get operation history | “Show operation history” |
Integrations (3)
| Tool | Description | Example Prompt |
|---|---|---|
ListIntegrations | List the integrations connected to your organization | “Which integrations do we have connected?” |
GetIntegration | Get one integration, by partner and service | “Show our Salesforce integration” |
CheckIntegration | Run an integration’s verification checks against the partner and return the outcome | “Check that our Slack integration still works” |
CheckIntegration runs the checks the integration card’s Verify runs, and they act on the
partner: a Slack integration posts a verification message to its channel, an Amazon S3 integration
writes and deletes a test object in its bucket, and some integrations update the details Fours
stores about them. It doesn’t change the integration’s status or start a sync. It needs the same
permission as Verify, and the checks usually take a few seconds. See
Integrations.
Workflow Executions (3)
| Tool | Description | Example Prompt |
|---|---|---|
QueryWorkflowExecutions | Find your workflows’ runs — filter and sort by workflow, status (new, running, success, failed, expired, declined), mode or start time; newest first | “Which workflow runs failed this week?” |
GetWorkflowExecution | Get one run’s status, mode, timing and retry links | “Show the status of the latest run of workflow wf-123” |
GetWorkflowExecutionData | Get what a run produced, node by node, with the workflow as it ran — to see what flowed through each node or why it failed; the result can be large | “Why did the last run of workflow wf-123 fail?” |
See Workflow for building the workflows these runs come from.
API Management (2)
| Tool | Description | Example Prompt |
|---|---|---|
ListApiClients | List API clients | “Show all API clients” |
GetApiClient | Get API client details | “Get API client details” |
Auditing (1)
| Tool | Description | Example Prompt |
|---|---|---|
QueryAuditingEvents | Query audit events | “Show audit events from the past 7 days” |
Common Parameters
These parameters recur across the catalog: almost every tool takes orgId, and each of the others appears on only some tools. Your AI assistant discovers the full schema for each tool automatically — you don’t need to specify parameters manually.
| Parameter | Type | Description |
|---|---|---|
orgId | string | Organization ID (required, path parameter) |
partner | string | Cloud partner filter: AWS, AZURE, GCP. The revenue tools also take SNOWFLAKE and ORACLE for raw billing rows, and STRIPE for receivables invoices, payouts and credit memos. On a co-sell referral, SUGER means a partner company you work with through Fours rather than a cloud provider: the …SugerCosellReferral tools take it, and ListAllCosellReferrals can filter on it. |
limit | number | Page size for list operations |
offset | number | Pagination offset |
Spotted something wrong or out of date on this page? Tell us and we'll correct it.