Tools Reference

Every MCP tool the Subscriby server exposes today, grouped by category, with the ability each one enforces.

161 tools across read, write, analytics and async-polling surfaces. Every write goes through the same business-logic layer that powers the dashboard, so plan-limit enforcement, cache invalidation and policy gates all run identically. Every count and table on this page is generated from the server's own export.

Machine-readable catalog

The authoritative, auto-generated list is published at:

GET https://api.subscriby.net/mcp-tools.json

Sibling artifacts at the same host — regenerated on every deploy:

  • https://api.subscriby.net/abilities.json — full ability catalog.
  • https://api.subscriby.net/error-codes.json — error code / HTTP status / remediation.
  • https://api.subscriby.net/webhook-events.json — every outbound webhook event.

Read tools

56 tools that never mutate state.

ToolRequired ability
find_member_by_identityproject-user:view-any
get_activity_logactivity:read
get_canned_replysupport-canned-reply:view-any
get_connectorproject-connector:view-any
get_connector_installationproject-connector:view
get_connector_uninstall_previewproject-connector:view
get_couponproject-coupon:view
get_deep_linkdistribution:read
get_meaccount:read
get_pass_windowpass-window:view
get_payment_methodproject-payment-method:view
get_planproject-subscription-plan:view
get_portal_urldistribution:read
get_projectproject:view
get_recovery_allowancesproject-recovery:view-any
get_recovery_readinessproject-recovery:view-any
get_recovery_roll_callproject-recovery:view
get_recovery_settingsproject-recovery:view
get_resourceproject-resource:view
get_resource_standbyproject-recovery:view
get_subscriberproject-user:view
get_subscriptionproject-subscription:view
get_support_conversationsupport-conversation:view
get_support_settingsproject:view
get_teamteam:view
get_webhook_deliverywebhook-delivery:view-any
get_webhook_endpointwebhook-endpoint:view
list_access_codesproject-access-code:view-any
list_canned_repliessupport-canned-reply:view-any
list_connector_installationsproject-connector:view-any
list_connectorsproject-connector:view-any
list_couponsproject-coupon:view-any
list_creator_tasksproject-subscription:view
list_groupsgroup:view-any
list_member_identitiesproject-user:view
list_notificationsaccount:read
list_pass_windowspass-window:view-any
list_payment_methodsproject-payment-method:view-any
list_plansproject-subscription-plan:view-any
list_projectsproject:view-any
list_recent_paymentsproject-subscription:view-any
list_recovery_incidentsproject-recovery:view-any
list_recovery_operationsproject-recovery:view-any
list_resourcesproject-resource:view-any
list_rolesrole:view-any
list_subscribersproject-user:view-any
list_subscription_grantsproject-subscription:view
list_support_conversationssupport-conversation:view-any
list_team_membersteam-member:view-any
list_teamsteam:view-any
list_tokenstoken:view-any
list_transactionsproject-subscription:view-any
list_webhook_deliverieswebhook-delivery:view-any
list_webhook_endpointswebhook-endpoint:view-any
preview_access_code_costproject-access-code:create
preview_broadcast_audiencebroadcast:send

Write tools

97 tools that change something. The 82 marked ⚠️ are annotated destructive, so a client that supports it will ask a human before running them.

ToolRequired ability
activate_coupon ⚠️project-coupon:update
activate_payment_method ⚠️project-payment-method:update
activate_resource ⚠️project-resource:update
archive_project ⚠️project:update
assign_support_conversation ⚠️support-conversation:update
ban_member ⚠️project-user:update
block_support_contact ⚠️support-conversation:update
broadcast_message ⚠️broadcast:send
bulk_generate_access_codes ⚠️project-access-code:create
cancel_pass_window ⚠️pass-window:delete
cancel_subscription ⚠️project-subscription:update
cancel_team_invitation ⚠️team-member:remove
complete_creator_task ⚠️project-subscription:update
create_canned_reply ⚠️support-canned-reply:create
create_coupon ⚠️project-coupon:create
create_group ⚠️group:create
create_pass_window ⚠️pass-window:create
create_plan ⚠️project-subscription-plan:create
create_project ⚠️project:create
create_resource ⚠️project-resource:create
create_role ⚠️role:create
create_team ⚠️team:create
create_webhook_endpoint ⚠️webhook-endpoint:create
deactivate_coupon ⚠️project-coupon:update
deactivate_payment_method ⚠️project-payment-method:update
deactivate_resource ⚠️project-resource:update
delete_canned_reply ⚠️support-canned-reply:delete
delete_coupon ⚠️project-coupon:delete
delete_group ⚠️group:delete
delete_payment_method ⚠️project-payment-method:delete
delete_plan ⚠️project-subscription-plan:delete
delete_project ⚠️project:delete
delete_resource ⚠️project-resource:delete
delete_role ⚠️role:delete
delete_team ⚠️team:delete
delete_webhook_endpoint ⚠️webhook-endpoint:delete
disconnect_connector ⚠️project-connector:delete
install_connectorproject-connector:create
invite_team_member ⚠️team-member:invite
kick_member ⚠️project-user:update
mark_all_notifications_readaccount:write
mark_notification_readaccount:write
notify_members_of_recovery ⚠️project-recovery:update
nudge_pending_readmissionsproject-recovery:update
pause_subscription ⚠️project-subscription:update
pause_webhook_endpoint ⚠️webhook-endpoint:update
publish_plan ⚠️project-subscription-plan:update
reactivate_subscription ⚠️project-subscription:update
reissue_subscription_grants ⚠️project-subscription:update
remind_pass_holder ⚠️project-subscription:update
remind_pass_window_queue ⚠️pass-window:update
remove_resource_standby ⚠️project-recovery:delete
remove_standby_installation ⚠️project-recovery:delete
remove_team_member ⚠️team-member:remove
reopen_support_conversation ⚠️support-conversation:update
reorder_plans ⚠️project-subscription-plan:update
reply_support_conversation ⚠️support-conversation:update
request_resource_linkproject-resource:create
request_resource_replacementproject-recovery:create
request_resource_standbyproject-recovery:create
resolve_support_conversation ⚠️support-conversation:update
restore_connector_accessproject-connector:update
restore_project ⚠️project:update
resume_webhook_endpoint ⚠️webhook-endpoint:update
retry_dead_webhook_deliveries ⚠️webhook-delivery:retry
retry_webhook_delivery ⚠️webhook-delivery:retry
revert_recovery_operation ⚠️project-recovery:update
revoke_token ⚠️token:delete
rotate_webhook_endpoint_secret ⚠️webhook-endpoint:update
run_connector_doctorproject-connector:update
set_resource_standby_mirrorproject-recovery:update
start_next_season ⚠️project-subscription-plan:create
sync_group_members ⚠️group:update
sync_payment_method_plans ⚠️project-payment-method:update
test_webhook_endpoint ⚠️webhook-endpoint:update
unban_member ⚠️project-user:update
unblock_support_contact ⚠️support-conversation:update
uninstall_connector ⚠️project-connector:delete
unlink_member_identity ⚠️project-user:update
unlink_resource ⚠️project-resource:update
unpause_subscription ⚠️project-subscription:update
update_canned_reply ⚠️support-canned-reply:update
update_connector_installation_settingsproject-connector:update
update_coupon ⚠️project-coupon:update
update_group ⚠️group:update
update_plan ⚠️project-subscription-plan:update
update_project ⚠️project:update
update_recovery_settingsproject-recovery:update
update_resource ⚠️project-resource:update
update_role ⚠️role:update
update_support_settings ⚠️project:update
update_team ⚠️team:update
update_team_member_role ⚠️team-member:update-role
use_resource_standby ⚠️project-recovery:create
verify_connector_installationproject-connector:update
withdraw_resource_replacement_requestproject-recovery:delete
withdraw_resource_standby_requestproject-recovery:delete

Analytics tools

7 tools that aggregate payment, subscription and dashboard data. All of them answer to dashboard:read.

ToolRequired ability
get_connector_analyticsdashboard:read
get_dashboard_metricsdashboard:read
get_earnings_reportdashboard:read
get_plan_performancedashboard:read
get_revenue_compositiondashboard:read
get_subscriber_analyticsdashboard:read
get_transaction_breakdowndashboard:read

Async polling

1 tool for checking the status of long-running jobs enqueued by other tools (today, only bulk_generate_access_codes enqueues).

ToolRequired ability
get_job_status

Visibility is locked to jobs the caller originally kicked off, which is why no separate ability gates it — polling reveals nothing you did not already cause, and the tool that enqueued the work enforced its own ability.

See async jobs for the full lifecycle.

Resource catalogs

Alongside tools, the server exposes 6 read-only resources:

  • subscriby://enums/abilityAPI Ability Catalog: Every ability a Sanctum personal access token can carry — core CRUD gates plus top-level scopes for team, role, group, token, payment, pass-window, support-canned-reply, webhook-endpoint, webhook-delivery, broadcast, bot, account, billing, dashboard, activity, platform admin and distribution. MCP and REST answer to the same catalog: a tool requires the same ability its REST equivalent does, so mint for the operations you intend to call rather than for the channel. Read once at session start to know what the current token can do and to mint future tokens with the minimum-privilege list. Returns { abilities: [{value, category, label}], core_count, extras_count, total }.
  • subscriby://enums/error-codeAPI Error Code Catalog: Every error code the API surface and MCP tools can emit. Each entry carries HTTP status, default message, remediation hint, and a docs_url anchor. Read this whenever a tool response carries an error envelope so the agent can pick the right remediation before retrying. Returns { error_codes: [{code, http_status, message, remediation, docs_url}] }.
  • subscriby://connectors/catalogConnector Catalog: Every connector Subscriby knows, lane by lane: status (available, beta, paused, in_development, coming_soon), installable, official, badges, category, tagline, links and, for a connector that exists as a package, its manifest (resource kinds with their grant mode, capabilities, messaging limits, pacing, the management commands it renders and the ones it misses, recovery facets) and the declarative install and settings fields a client renders as the connect form. Read this before proposing a connector for a project or explaining what one can do. Returns { connectors: [card], total }.
  • subscriby://enums/payment-providerPayment Providers: The payment-provider keys Subscriby supports: the gateway codes (Stripe, PayPal, Razorpay, Paystack, CoinPayments, Skrill, CeyPay), access codes, and one connector:provider key per native currency a connector brings, which can only be configured on a project where that connector is connected. Most flows use payment-method UUIDs from list_payment_methods rather than provider codes; consult this resource only when you need the canonical provider string. Returns { payment_providers: [{value, connector, requires_connector, legacy_alias}] }; platformcurrency is the legacy alias earlier native rows were stored under.
  • subscriby://enums/subscription-statusSubscription Status Catalog: Every status a subscription or payment row can hold, with the human label and the dashboard color family. Read this before reasoning about lifecycle — e.g. is past_due a dunning trigger, is capturable retryable, is canceled terminal? Avoids hard-coding free-text status strings on the agent side. Returns { subscription_statuses: [{value, label, color}] }.
  • subscriby://enums/webhook-eventOutbound Webhook Event Catalog: Every outbound webhook event Subscriby can emit, grouped by family (project, plan, member, subscription, payment, access-code, etc.). Each row carries the minimum ability a subscribing creator must hold to receive that event. Read this before configuring a webhook endpoint or wiring up an external automation (Zapier, n8n) so the event allow-list lines up with the events the source actions actually produce. Returns { webhook_events: [{name, family, required_ability}], families: [string] }.

Clients that support resource browsing pick any of these as context before driving the tools. See the resources reference for payload shapes.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request