Skip to content

Merchant MCP tools

Every tool the merchant MCP server offers.

Updated

Connect your agent to https://mcp.sherpo.io/mcp. The server lists the tools your grant’s scopes allow. A tool that acts on a store takes a store argument, which is required when your grant reaches more than one store.

Tool What it does
Run bulk change Runs one bulk-capable change over many rows in one transaction, answering each item’s outcome.
List product categories Lists the product categories the store may use.
List products Pages the store’s products.
Read product Reads one product with its tiers and prices.
Read product summaries Reads the short summaries of up to a page of products by id, with where each stands.
Create product Creates a draft product.
Update product Updates a product’s fields.
Publish product Publishes a product now or schedules it.
Unpublish product Takes a product back to draft.
Discontinue product Stops selling a product while keeping it for its holders.
Reinstate product Sells a discontinued product again.
Unlist product Hides a product from the store’s listings while keeping its page reachable.
Relist product Shows an unlisted product in the store’s listings again.
Delete product Deletes a product no order, grant or subscription refers to.
List tiers Pages the tiers of the store’s products, or of one product.
Create tier Adds a tier to a product, with the settings its category takes, such as the features a software tier’s licenses unlock.
Update tier Renames a tier or changes its settings, such as the features a software tier’s licenses unlock.
Reorder tiers Sets the order of a product’s tiers.
Delete tier Deletes a tier no price or holder refers to.
List prices Pages the prices of the store’s products, or of one product.
Create price Adds a price to a product’s tier.
Update price Updates a price’s fields.
Highlight price Makes a price the one a product’s page features.
Archive price Stops offering a price while keeping it for its buyers.
Restore price Offers an archived price again.
Delete price Deletes a price no order or subscription refers to.
List entries Pages a product’s entries, a blog’s drafts first then newest first, a podcast’s newest first, unless sorted.
List entries in full Pages a product’s entries, each read whole, a blog’s drafts first then newest first, a podcast’s newest first, unless sorted.
Read entry Reads one entry.
Count entries Counts a product’s entries by status and section.
Create entry Creates a draft entry in a product.
Update entry Updates an entry’s fields.
Publish entry Publishes an entry now or schedules it.
Unpublish entry Takes an entry back to draft.
Reorder entries Sets the order of a product’s entries.
List entry sections Pages the distinct sections a product’s entries hold, with how many hold each.
List entry tags Pages the distinct tags a product’s entries hold, with how many hold each.
List sections Lists a product’s entry sections.
Create section Adds an entry section to a product.
Rename section Renames a product’s entry section.
Remove section Removes a product’s entry section, its entries kept outside any section.
Delete entry Deletes an entry.
List pages Pages the store’s custom pages.
Read page Reads one custom page.
Create page Creates a draft custom page.
Update page Updates a custom page’s fields.
Publish page Publishes a custom page now or schedules it.
Unpublish page Takes a custom page back to draft.
Delete page Deletes a custom page.
List attachments Lists the files attached to a resource.
Read body schema Answers what a save takes for a kind of body: its block types, each block’s props with their types, values and limits, which are required, and where blocks may sit.
Read body Reads what the store’s home, a page, a product or an entry renders, its body or the default layout without one, and a quiz’s or certificate’s body; staged reads the unpublished one, and default the default layout even over a body. getBodySchema answers the blocks and props each kind of body takes.
Set body Writes the live body of the store’s home, a page, a product or an entry, or with staged: true its unpublished next body, which publishBody publishes; from names the body read, so a write over one changed since is refused. Ask getBodySchema for the blocks, props and values its kind takes before writing: anything else is refused, naming the block, the prop and what it takes.
Edit body blocks Updates, inserts, moves or deletes blocks of a body by id, without sending it whole. getBodySchema answers the props each block takes.
Publish body Publishes the staged body.
Discard staged body Discards the staged body, keeping the published one.
Attach file Attaches a file to a resource in a role.
Update attachment Updates an attachment’s role, delivery or preview flag.
Reorder attachments Sets the order of a resource’s attachments.
Detach file Detaches a file from a resource, keeping the file.
List prompts Pages a product’s MCP prompts with their text.
Read prompt Reads one of a product’s MCP prompts.
Create prompt Adds an MCP prompt to a product.
Update prompt Updates an MCP prompt’s fields, text or access.
Delete prompt Deletes an MCP prompt.
Set product thumbnail Sets, swaps or clears a product’s thumbnail, its first poster, if it is still the one the caller saw.
List access requirements Lists the tiers that unlock a product, entry, page or file.
List access of resources Reads the access requirements of many resources at once.
Set access requirement Requires a tier to unlock a resource.
Clear access requirement Removes a tier requirement from a resource.
List files Pages the store’s files.
Read file Reads one file.
Read storage quota Reads the store’s storage use against its plan’s allowance, and the time zone its files’ deliveries are dated in.
List media AI outputs Lists a video’s or audio file’s AI outputs (subtitles, transcript, summary, chapters) and where each one’s generation stands.
Read media AI output Reads one of a video’s or audio file’s AI outputs with its content.
Generate media AI output Generates one of a video’s or audio file’s AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.
Update media AI output Edits one of a video’s or audio file’s AI outputs: the subtitles’ cues, or the transcript’s, summary’s or chapters’ content.
Publish media AI output Publishes one of a video’s or audio file’s AI outputs to customers, or takes it back to a draft.
Delete media AI output Deletes one of a video’s or audio file’s AI outputs.
Create link file Creates a link file, such as an external video.
Create upload Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.
Create inline upload Uploads a file of at most 2 MiB with its bytes in the call, for a client that cannot send them to an upload URL.
Complete upload Marks an upload done once its bytes are in place.
Cancel upload Cancels an upload that was never completed.
Get file URL Mints a short-lived URL to a file’s bytes.
Update file Updates a file’s name, title, description and security level.
Move file Moves a file between public and private storage.
Replace file Replaces a file’s bytes with another upload’s, keeping where it is used and deleting a video’s or audio file’s AI outputs.
Delete file Deletes a file nothing uses.
Read store stats Reads the store’s takings and audience stats over a period.
Read order stats Reads the store’s order totals over a period of any length, against the span before it.
Read store totals Reads the store’s takings and audience totals since its first order.
Read customer stats Reads the store’s customer stats over a period.
Read subscription stats Reads the store’s subscription stats over a period.
Read product stats Reads a product’s sales and audience stats over a period.
Count products Counts the store’s products by status.
Count product files Counts a product’s files and links by kind.
Read traffic stats Reads the store’s views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.
Read conversion stats Reads the store’s product views, checkouts started and orders over a period, by channel and product.
Read API call stats Reads the calls customers’ apps made to the store over the API and MCP over a period, by channel and client.
Read product traffic stats Reads a product’s views, visitors, checkouts started and orders over a period, by channel.
List orders Pages the store’s orders.
Read order Reads one order.
List order lines Pages an order’s lines.
List order settlements Pages an order’s settlements.
List order refunds Pages an order’s refunds.
List order commissions Pages the affiliate commissions an order earned.
Record refund Records a refund of an order, optionally revoking what it granted.
Record order Records an order paid outside the store, granting what it bought.
Simulate checkout Prices each of a product’s prices as the checkout would charge a customer, or a new one, with an optional coupon, quantity and later time, writing nothing; naming a customer needs customer:read, and a coupon discount:read.
Record affiliate payout Records a payout made to an affiliate.
List commissions Pages the commissions affiliates earned.
Read commission stats Reads commission totals over a period.
List affiliate payouts Pages the payouts recorded to affiliates.
List discounts Pages the store’s discounts.
Read discount Reads one discount.
Count discounts Counts the store’s discounts by status.
Create discount Creates a discount.
Update discount Updates a discount’s fields.
Archive discount Stops a discount from applying while keeping it.
Restore discount Lets an archived discount apply again.
Delete discount Deletes a discount no payable checkout, unpaid commission or automation relies on.
List affiliates Pages the store’s affiliates by discount.
Set affiliate Makes a user an affiliate of a discount, with their commission.
Remove affiliate Removes an affiliate from a discount, or ends one that earned commissions, which stay.
Revert affiliate Puts back the commission an affiliate had before an API token that did not make it changed it.
Restrict discount Sets the products, tiers or prices a discount applies to.
Attach discount Applies a discount to a product, tier or price.
Detach discount Stops a discount applying to a product, tier or price.
List subscriptions Pages the store’s subscriptions.
List subscription periods Pages the billing periods of subscriptions.
List subscription changes Pages the status changes of subscriptions.
Read subscription Reads one subscription.
Cancel subscription Cancels a subscription now or at the end of its period.
Resume subscription Withdraws a subscription’s scheduled cancellation.
List grants Pages the grants of access to customers.
Grant access Grants a customer access to a product or tier.
Revoke grant Revokes a grant of access.
Revoke access Revokes a customer’s access to a purchase’s products, or a grant’s, for cause: their access ends at once, their subscriptions to them stop, the customer is mailed with an optional message, and an optional refund is sent through Stripe or recorded.
List revocations Pages the revocations of customers’ access for cause, of one customer or one order when named, with each one’s refund.
Retry revocation refund Sends a revocation’s failed Stripe refund again.
List private feeds Pages customers’ private feeds of blogs, podcasts and events, with the readers each served lately and its limit.
Update feed reader limit Sets how many readers a customer’s private feed serves in 30 days before it moves to a new URL.
Revoke private feed Stops a customer’s private feed of a blog, a podcast or an event.
Unblock private feed Lets a customer hold a private feed of a blog, a podcast or an event again after repeated sharing turned it off, counting sharing afresh.
List licenses Pages a software product’s licenses, their keys shortened to their last characters.
Read license Gets a license with its key, its status and the subscription behind it.
Update license Sets a license’s activation limit, its uses or its metadata.
Disable license Stops a license from checking as valid, whatever its holder’s access.
Enable license Lets a disabled license check as its holder’s access says again.
Record license key Records a key a customer holds from another platform as their license to a software product, so software in the field keeps checking; it may land disabled, or take the place of the customer’s license.
Read license stats Reads a software product’s license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.
List license activations Pages the devices a license counts, latest activated first, with those freed or gone inactive, never their instance ids.
Deactivate license device Frees one of a license’s devices, so it stops counting toward the activation limit, whatever the license’s status.
Rotate license key Gives a license a fresh key and emails it to the holder; the old key stops checking at once.
Verify license Checks a software product’s license key from the seller’s server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with count_use an active one counts a use, and with instance it reads and stamps that device. An unknown key, or another product’s, answers not_found.
Activate license Counts a device toward a software product’s license from the seller’s server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license’s activation limit (10,000 when nothing limits it) it answers conflict on items, and a license that is not active conflict on status.
Refresh license token Answers a fresh signed token for a device a software product’s active license counts, from the seller’s server, stamping the device seen; a license that is not active answers conflict on status, and a device it does not count (never activated, freed or gone inactive) not_found.
Deactivate license Frees a device of a software product’s license from the seller’s server, whatever the license’s status, an inactive one too; a device never activated, or already freed, answers not_found.
List license signing keys Lists the store’s published Ed25519 keys as JSON Web Keys, which software checks offline license tokens against: the one that signs, the next one, and those rotated out while a token they signed may live.
Rotate license signing keys Promotes the store’s next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with retire_previous every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With current, a rotation since answers conflict. A store with no keys gets its first set.
List entitlements Pages what customers may reach, as their grants and subscriptions add up.
List customers Pages the store’s customers.
List customer activity Pages customers’ activity over a period.
List product customers Pages a product’s customers.
Count product customers Counts a product’s customers by status.
List checkouts Pages the store’s checkouts.
Read customer Reads one customer.
Erase customer Erases a customer’s personal data, keeping the records of what they bought.
List reviews Pages the store’s product reviews.
Read review stats Reads review counts and ratings.
Hide review Hides a review from the store.
Unhide review Shows a hidden review again.
Reply to review Sets or clears the store’s reply to a review.
List quiz attempts Pages customers’ quiz attempts.
Read quiz attempt Reads one quiz attempt with its answers.
List certificates Pages a product’s certificates.
List issued certificates Pages the certificates issued to customers.
Read certificate stats Reads a product’s certificate issues over a period.
List file deliveries Pages the deliveries of files from the last year, newest first, with the file, who it went to and its state, in the store’s time zone.
List file uses Pages where files are used.
Issue certificate Issues a certificate to a customer.
List quizzes Pages an entry’s quizzes.
Read quiz Reads one quiz with its questions.
Read quiz stats Reads a product’s quiz results.
Create quiz Creates a quiz on an entry.
Update quiz Updates a quiz’s settings and questions.
Delete quiz Deletes a quiz.
Clear quiz attempts Clears a customer’s attempts at an entry’s quizzes.
Delete quiz attempt Deletes one quiz attempt.
Create certificate Creates a certificate for a product.
Update certificate Updates a certificate’s design and copy.
Delete certificate Deletes a certificate never issued.
Revoke issued certificate Revokes an issued certificate.
List event attendees Pages an event’s guest list: one row per person, going or canceled, with their tier and how they got their ticket.
Count event attendees Counts an event’s attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.
List product questions Pages the registration questions a product asks its buyers in checkout, in order.
Create product question Adds a registration question to a product, its own or a standard detail: a text, a select or a checkbox, required or not.
Update product question Rewords a product question, makes it required or not, changes its options or pattern, or moves it.
List customer answers Reads a customer’s answers to each product’s registration questions, latest answered first.
Set customer answers Answers a product’s registration questions for a customer who holds it, such as answers they gave elsewhere.
Delete product question Stops asking a product question, dropping its answers.
Check in event attendee Lets an attendee in at one of an event’s sessions by their ticket’s code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.
Undo attendee check-in Takes back an attendee’s check-in at an event’s session.
Count event check-ins Counts an event’s door: who is going, and each session with how many were let in.
List events to check in Lists the events with a session held in person still to run or ended in the last 12 hours, soonest first, each with who is going and how many were let in.
List product requests Pages a product’s requests: buyers waiting for approval, an event’s waitlist, and those decided.
Approve product request Approves a pending request: the buyer is granted what they asked for, on the seats their order holds.
Decline product request Declines a pending request or a waitlist place, giving back any seats it holds.
Promote from waitlist Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.
List event sessions Pages an event’s sessions, earliest first.
Create event session Adds a session to an event, with its start, end, time zone and place.
Update event session Moves an event session or changes its place.
Delete event session Takes a session off an event’s schedule.
Cancel event Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.
Read event cancellation Reads an event’s cancellation and its refunds by status; null while the event stands.
List event refunds Pages a canceled event’s refunds: what each gives back, where it stands, and why one failed.
Retry event refund Tries a canceled event’s failed refund again.
Read store Reads the store: its name, hostname, subdomain, branding and plan.
Read store settings Reads the store’s settings.
Read plan and usage Reads the store’s plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.
Update store settings Updates the store’s settings.
Update store Updates the store’s name, description and branding.
Read domain Reads the store’s own domain, if it has one: where it stands, the DNS records it needs, and whether the store’s plan includes a domain.
Connect domain Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store’s main address once they check out, or at once when it already does. Needs a plan that includes a domain.
Check domain Checks the store’s own domain at Cloudflare now, making it the store’s main address once its records check out while the plan includes a domain; a check moments after another answers the domain as last read.
Remove domain Stops serving the store on its own domain, or dismisses one that was let go; its Sherpo address becomes its main address again. Answers not found when the store has no domain, as after a removal that already landed.
Set store icon Sets or clears the store’s icon from a file.
Read business Reads the store’s business.
Update business Updates the business’s name and details.
Set business logo Sets or clears the business’s logo from a file.
Read payout balance Reads the business’s payout balance.
List payouts Lists the business’s payouts.
Preview extra store cost Previews what one more store on the business’s plan charges now and bills from its next renewal.
Preview plan change Previews switching the business’s plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn’t drop and the period doesn’t shorten; any other switch from the period’s end.
Change plan Switches the business’s plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period’s end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.
Confirm plan change Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.
Cancel plan change Cancels a plan switch scheduled for the period’s end, so the plan renews as it is. A store slot’s removal is cancelled on its own. Only a member with full access cancels it.
Set plan auto-upgrade Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro’s price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.
Set automatic add-ons Turns on or off adding Pro’s add-on blocks on their own: when a store’s storage or AI media minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what’s covered. On by default for new businesses.
List notifications Pages the store’s customer notifications.
Create notification Creates a customer notification for an event.
Update notification Updates whether a notification is enabled.
Delete notification Deletes a notification; the store’s defaults are turned off instead.
List webhooks Pages the store’s webhook endpoints.
Read webhook Reads one webhook endpoint, never its secret.
Create webhook Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.
Update webhook Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events’ payloads carry.
Delete webhook Deletes a webhook endpoint and its delivery history.
Roll webhook secret Replaces a webhook endpoint’s signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.
List webhook deliveries Pages a webhook endpoint’s recent deliveries: status, attempts and last response code.
Resend webhook delivery Sends a delivery’s event to its endpoint again, with the same event id; needs the read scopes its payload carries.
List redirects Pages the store’s redirects.
Create redirect Creates a redirect from a path.
Update redirect Updates a redirect’s source or destination.
Delete redirect Deletes a redirect.
Check path Says whether a path is free for a page or redirect.
List integrations Lists the store’s integrations and their settings.
Set integration Sets or clears an integration’s settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.
List automations Pages the store’s automations.
List automation runs Pages the runs of automations.
Read automation Reads one automation.
Create automation Creates an automation; an unlock needs customer:write too, a price adjustment discount:write, and each needs the read scope of what it names.
Update automation Updates an automation’s trigger and action; a new trigger or action needs the scopes creating the rule would.
Pause automation Pauses an automation.
Resume automation Resumes a paused automation; an unlock needs customer:write too, a price adjustment discount:write.
Delete automation Deletes an automation.
Read portfolio Reads a portfolio product’s book: settings, metrics and value.
Value portfolio Values a portfolio at live quotes and prices its watchlist.
List holdings Pages a portfolio’s holdings.
Update portfolio Updates a portfolio’s settings.
Update holding Updates a holding’s note.
List holding files Lists the files announced with a holding.
List portfolio events Pages a portfolio’s events: trades, cash and notes.
Record portfolio event Records a trade, cash movement or note in a portfolio.
List portfolio snapshots Pages a portfolio’s daily snapshots.
List software activity Pages a software product’s releases and notes, newest first.
Record software activity Records a release, whose files become the current download, or a note on a software product.
Update software activity Updates a release’s version, notes, files or tier, or a note.
Delete software activity Deletes a release, with its files, or a note.
Search symbols Searches the market for symbols by name or ticker.
Quote symbols Reads the latest quotes for symbols.
List businesses Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.
Read business and stores Reads one business with its stores.

Type to search…

↑↓ navigate↵ selectEsc close