Skip to content

MCP tools reference

This content is not available in your language yet.

An assistant sees only the groups its connection has and the tools its access level allows. The descriptions are in English because they are the text the assistant reads.

Tools Groups Package version
73 5 @posty5/mcp 1.3.0

Access levels

account

Who the connection is, your credits, and what each action costs

ToolAccessAsks you firstWhat it does
account_get_currentreadThe Posty5 account this connection acts for.
account_get_creditsreadThe account's credit balance and what this period has used.
account_get_credit_usagereadThe credit ledger, newest first.
account_get_credit_transfer_eligibilityreadWhether this account can send credits to another Posty5 account (Business plan only), how many it can send, and whether it can still receive a transfer on the Free plan.
account_list_credit_transfersreadCredits this account sent to or received from other Posty5 accounts, newest first.
account_get_operation_costsreadThe live credit price of every paid operation, grouped by module.

Create, find, edit and delete short links

ToolAccessAsks you firstWhat it does
short_link_listreadShort links, newest first, with their short URL, target and visit count.
short_link_getreadOne short link with its full details.
short_link_get_analyticsreadVisits to one short link over a date range.
short_link_createwriteCreates a short link to baseUrl and returns its short URL and QR code URLs.
short_link_create_manywriteYesCreates 1 to 25 short links in one call.
short_link_updatewriteChanges a short link's target, details or controls.
short_link_deletefullYesDeletes a short link.
short_link_set_ruleswriteSets a short link's controls.
short_link_list_tagsreadThe distinct tags on your short links, sorted, at most 200.
short_link_check_healthwriteQueues one health check of the link's destinations.
short_link_campaign_listreadLink campaigns.
short_link_campaign_getreadOne link campaign with its default UTM, linkCount and totalVisits (the sum of its links' visits).
short_link_campaign_createwriteCreates a link campaign.
short_link_campaign_updatewriteChanges a link campaign.
short_link_campaign_deletefullYesDeletes a link campaign.

qr-codes

QR codes of every type, and the templates that style them

ToolAccessAsks you firstWhat it does
qr_code_listreadQR codes, newest first, with their type, mode (static or dynamic), dynamicSince, landing page URL, image URL and scan count.
qr_code_getreadOne QR code with its full details.
qr_code_renderreadA signed download link for a QR code's image as PNG, SVG or PDF, optionally at a print size (presetId) and, for PNG, a resolution (dpi).
qr_code_check_scannabilityreadChecks whether a QR code (qrCodeId) or a template (templateId, from qr_code_list_templates) will scan reliably.
qr_code_get_analyticsreadVisits that reached Posty5 through one QR code over a date range.
qr_code_list_templatesreadThe templates that style a QR code — every QR code needs one.
qr_code_createwriteCreates a QR code of the given type and returns its mode, landing page URL and image URL.
qr_code_create_manywriteYesCreates 1 to 25 QR codes in one call; each row takes the same type and fields as qr_code_create, and needs a templateId (or one in defaults).
qr_code_get_bulk_jobreadThe status and counters of a QR bulk job started by qr_code_create_many with zip.
qr_code_updatewriteReplaces a QR code's target.
qr_code_deletefullYesDeletes a QR code.

html-hosting

Hosted pages, their variables and their form submissions

ToolAccessAsks you firstWhat it does
html_page_listreadHosted HTML pages, newest first, with their URL, source (file or GitHub), status, visits and form submission count.
html_page_getreadOne hosted page with its full details.
html_page_lookupreadEvery page's _id, name and short code in one light list — for finding a page's id.
html_page_list_formsreadThe forms Posty5 found on a page, with each form's formId and field names.
html_page_create_from_htmlwritePublishes the given HTML as a new hosted page (uploaded as index.html) and returns its _id and URL.
html_page_create_from_githubwritePublishes an HTML file from a public GitHub repository as a new hosted page and returns its _id and URL.
html_page_update_from_htmlwriteReplaces a hosted page's content with the given HTML.
html_page_update_from_githubwriteReplaces a hosted page's content with an HTML file from a public GitHub repository.
html_page_clean_cachewriteClears the cached copy of a hosted page so visitors get its latest content at once.
html_page_deletefullYesDeletes a hosted page.
html_variable_listreadRuntime variables.
html_variable_getreadOne runtime variable.
html_variable_createwriteCreates a runtime variable hosted pages can read by its key (which must start with "pst5_").
html_variable_updatewriteChanges a runtime variable.
html_variable_deletefullYesDeletes a runtime variable.
form_submission_listreadWhat visitors submitted through one hosted page's forms, newest first, with each submission's data and status.
form_submission_getreadOne form submission with its data, status history, page and form.
form_submission_get_adjacentreadThe ids and numbers of the submissions just before and after this one on the same page, for stepping through them.
form_submission_change_statuswriteMoves a form submission to a new status (e.g.
form_submission_deletefullYesDeletes one form submission.

social-publisher

Workspaces, connected accounts, and posts to every platform

ToolAccessAsks you firstWhat it does
social_workspace_listreadSocial publishing workspaces, newest first.
social_workspace_getreadOne workspace with the account connected to it on each platform.
social_workspace_get_for_new_postreadA workspace's connected accounts per platform, as a new post sees them.
social_account_listreadSocial accounts connected to Posty5, with platform and status.
social_account_getreadOne connected account.
social_workspace_createwriteCreates an empty workspace and returns its workspaceId.
social_workspace_updatewriteChanges a workspace's name or description.
social_workspace_deletefullYesDeletes a workspace.
social_post_listreadPosts, newest first, with caption, status, schedule and target.
social_post_get_statusreadOne post's progress on each platform.
social_post_get_default_settingsreadThe default publishing settings saved for this Posty5 account — use them to fill platform blocks the user did not specify.
social_post_get_adjacentreadThe ids of the posts just before and after this one, for stepping through them.
social_post_publish_imagewritePublishes one image, from a public URL, with a caption — at once or at scheduledAt.
social_post_publish_short_videowritePublishes a short video (a reel, short or TikTok) from a public URL — at once or at scheduledAt.
social_post_quote_long_videoreadMeasures a video of up to 60 minutes from its URL and returns its duration, the credits publishing it would cost, and which platforms accept a video that long.
social_post_publish_long_videowriteYesPublishes a video of up to 60 minutes from a public URL — at once or at scheduledAt.
social_post_publish_textwritePublishes a text-only post — at once or at scheduledAt — to Facebook, Threads and X.
social_post_publish_storywritePublishes a story — one image or one video, from a public URL, with no caption — at once or at scheduledAt.
social_post_reschedulewriteMoves a post that has not published yet to a new time, or publishes it now ("now"), optionally replacing its caption.
social_post_deletefullYesDeletes a post that has not published yet, with its uploaded media.
social_post_remove_from_platformsfullYesDeletes a published post's media from the platforms it was published to, at once.