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.jsonSibling 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.
| Tool | Required ability |
|---|---|
find_member_by_identity | project-user:view-any |
get_activity_log | activity:read |
get_canned_reply | support-canned-reply:view-any |
get_connector | project-connector:view-any |
get_connector_installation | project-connector:view |
get_connector_uninstall_preview | project-connector:view |
get_coupon | project-coupon:view |
get_deep_link | distribution:read |
get_me | account:read |
get_pass_window | pass-window:view |
get_payment_method | project-payment-method:view |
get_plan | project-subscription-plan:view |
get_portal_url | distribution:read |
get_project | project:view |
get_recovery_allowances | project-recovery:view-any |
get_recovery_readiness | project-recovery:view-any |
get_recovery_roll_call | project-recovery:view |
get_recovery_settings | project-recovery:view |
get_resource | project-resource:view |
get_resource_standby | project-recovery:view |
get_subscriber | project-user:view |
get_subscription | project-subscription:view |
get_support_conversation | support-conversation:view |
get_support_settings | project:view |
get_team | team:view |
get_webhook_delivery | webhook-delivery:view-any |
get_webhook_endpoint | webhook-endpoint:view |
list_access_codes | project-access-code:view-any |
list_canned_replies | support-canned-reply:view-any |
list_connector_installations | project-connector:view-any |
list_connectors | project-connector:view-any |
list_coupons | project-coupon:view-any |
list_creator_tasks | project-subscription:view |
list_groups | group:view-any |
list_member_identities | project-user:view |
list_notifications | account:read |
list_pass_windows | pass-window:view-any |
list_payment_methods | project-payment-method:view-any |
list_plans | project-subscription-plan:view-any |
list_projects | project:view-any |
list_recent_payments | project-subscription:view-any |
list_recovery_incidents | project-recovery:view-any |
list_recovery_operations | project-recovery:view-any |
list_resources | project-resource:view-any |
list_roles | role:view-any |
list_subscribers | project-user:view-any |
list_subscription_grants | project-subscription:view |
list_support_conversations | support-conversation:view-any |
list_team_members | team-member:view-any |
list_teams | team:view-any |
list_tokens | token:view-any |
list_transactions | project-subscription:view-any |
list_webhook_deliveries | webhook-delivery:view-any |
list_webhook_endpoints | webhook-endpoint:view-any |
preview_access_code_cost | project-access-code:create |
preview_broadcast_audience | broadcast: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.
| Tool | Required 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_connector | project-connector:create |
invite_team_member ⚠️ | team-member:invite |
kick_member ⚠️ | project-user:update |
mark_all_notifications_read | account:write |
mark_notification_read | account:write |
notify_members_of_recovery ⚠️ | project-recovery:update |
nudge_pending_readmissions | project-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_link | project-resource:create |
request_resource_replacement | project-recovery:create |
request_resource_standby | project-recovery:create |
resolve_support_conversation ⚠️ | support-conversation:update |
restore_connector_access | project-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_doctor | project-connector:update |
set_resource_standby_mirror | project-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_settings | project-connector:update |
update_coupon ⚠️ | project-coupon:update |
update_group ⚠️ | group:update |
update_plan ⚠️ | project-subscription-plan:update |
update_project ⚠️ | project:update |
update_recovery_settings | project-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_installation | project-connector:update |
withdraw_resource_replacement_request | project-recovery:delete |
withdraw_resource_standby_request | project-recovery:delete |
Analytics tools
7 tools that aggregate payment, subscription and dashboard data. All of them answer to dashboard:read.
| Tool | Required ability |
|---|---|
get_connector_analytics | dashboard:read |
get_dashboard_metrics | dashboard:read |
get_earnings_report | dashboard:read |
get_plan_performance | dashboard:read |
get_revenue_composition | dashboard:read |
get_subscriber_analytics | dashboard:read |
get_transaction_breakdown | dashboard:read |
Async polling
1 tool for checking the status of long-running jobs enqueued by other tools (today, only bulk_generate_access_codes enqueues).
| Tool | Required 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/ability— API 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-code— API 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 anerrorenvelope so the agent can pick the right remediation before retrying. Returns{ error_codes: [{code, http_status, message, remediation, docs_url}] }.subscriby://connectors/catalog— Connector 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-provider— Payment Providers: The payment-provider keys Subscriby supports: the gateway codes (Stripe, PayPal, Razorpay, Paystack, CoinPayments, Skrill, CeyPay), access codes, and oneconnector:providerkey 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 fromlist_payment_methodsrather than provider codes; consult this resource only when you need the canonical provider string. Returns{ payment_providers: [{value, connector, requires_connector, legacy_alias}] };platformcurrencyis the legacy alias earlier native rows were stored under.subscriby://enums/subscription-status— Subscription 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. ispast_duea dunning trigger, iscapturableretryable, iscanceledterminal? Avoids hard-coding free-text status strings on the agent side. Returns{ subscription_statuses: [{value, label, color}] }.subscriby://enums/webhook-event— Outbound 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?