{"id":81433,"date":"2026-07-14T12:09:36","date_gmt":"2026-07-14T16:09:36","guid":{"rendered":"https:\/\/memberpress.com\/docs\/mcp-tools-reference\/"},"modified":"2026-07-14T12:09:36","modified_gmt":"2026-07-14T16:09:36","slug":"mcp-tools-reference","status":"publish","type":"ht_kb","link":"https:\/\/memberpress.com\/pt\/docs\/mcp-tools-reference\/","title":{"rendered":"Refer\u00eancia \u00e0s ferramentas MCP do MemberPress AI Foundation"},"content":{"rendered":"\n

The MemberPress AI Foundation MCP server exposes a catalog of tools that an AI client calls to read and manage MemberPress data. Each tool declares a name, a JSON input schema, and annotations that classify it as read-only, a write, or destructive.<\/p>\n\n\n\n

This reference lists every tool, grouped by domain, with its purpose, key parameters, required scope, and required WordPress capability. It is the companion to the Agent Safety Measures Reference<\/a><\/strong>, which explains how scopes, capabilities, and the confirmation flow are enforced.<\/p>\n\n\n\n

How the Tool List Works<\/a><\/h2>\n\n\n\n

A client retrieves the catalog by calling the tools\/list<\/code> method against the MCP endpoint. Two factors determine which tools appear in the response:<\/p>\n\n\n\n

    \n
  1. Connection access level (scope filtering).<\/strong> The server returns only the tools the connection's scope permits. A read-only connection (including any Application Password connection) sees only read tools. A connection with write scopes additionally sees the write and destructive tools its scopes cover. A tool is also hidden when the token owner lacks its required WordPress capability \u2014 memberpress_delete_member<\/code> does not appear for a user without delete_users<\/code>.<\/li>\n\n\n\n
  2. Active add-ons (add-on gating).<\/strong> Tools belonging to an add-on register only while that add-on is active. A site without MemberPress Courses, for example, does not expose the course tools.<\/li>\n<\/ol>\n\n\n\n

    Because of these two factors, the number of tools a site exposes varies. The catalog builds up by add-on:<\/p>\n\n\n\n

    Registration<\/th>Authenticated tools<\/th>Public tools<\/th><\/tr><\/thead>
    Core (no add-ons)<\/td>41<\/td>2<\/td><\/tr>
    + MemberPress Courses<\/td>+8<\/td>+2<\/td><\/tr>
    + Corporate Accounts<\/td>+3<\/td>\u2014<\/td><\/tr>
    + Downloads<\/td>+2<\/td>\u2014<\/td><\/tr>
    Everything active<\/strong><\/td>54<\/strong> (39 read, 9 non-destructive write, 6 destructive)<\/td>4<\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Note:<\/strong> The tool count seen on a given connection is not a fixed number. It reflects that connection's access level and the site's active add-ons. A lower count is normal, not a sign of a broken installation.<\/p>\n\n\n\n

    Tool Classifications<\/a><\/h3>\n\n\n\n

    Every tool carries annotations that classify it:<\/p>\n\n\n\n

    Classification<\/th>Annotation<\/th>Behavior<\/th><\/tr><\/thead>
    Read<\/td>readOnlyHint: true<\/code><\/td>Retrieves data. Never changes state. Available to every connection.<\/td><\/tr>
    Non-destructive write<\/td>readOnlyHint: false<\/code>, destructiveHint: false<\/code><\/td>Creates or updates. Defaults to a preview; pass execute: true<\/code> to run live.<\/td><\/tr>
    Destructive<\/td>readOnlyHint: false<\/code>, destructiveHint: true<\/code><\/td>Deletes, refunds, cancels, or resets. Requires the two-step confirmation-token flow.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    The write and destructive execution mechanics are documented in the Agent Safety Measures Reference<\/a><\/strong>. This reference focuses on what each tool is and what it accepts.<\/p>\n\n\n\n

    Tool Response Format<\/a><\/h2>\n\n\n\n

    A client runs a tool with the tools\/call<\/code> method. The result returns in the standard MCP envelope: a result.content<\/code> array whose first element is a text block. That block's text<\/code> field holds the tool's data as a JSON string<\/strong> the client must parse. This differs from the tools\/list<\/code> shape, which returns tool definitions directly.<\/p>\n\n\n\n

    The envelope from a memberpress_list_members<\/code> call:<\/p>\n\n\n\n

    {\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"result\": {\n    \"content\": [\n      { \"type\": \"text\", \"text\": \"{ ...escaped JSON string... }\" }\n    ]\n  }\n}<\/code><\/pre>\n\n\n\n
    Parsing the text<\/code> string yields the payload \u2014 a members<\/code> array with sibling pagination fields:<\/p>\n\n\n\n
    {\n  \"members\": [\n    {\n      \"id\": 50,\n      \"email\": \"member@example.com\",\n      \"username\": \"member50\",\n      \"first_name\": \"Example\",\n      \"last_name\": \"Member\",\n      \"registered_at\": \"2023-08-21 17:18:31\",\n      \"active_memberships\": [ { \"id\": 2332, \"title\": \"Basic Membership\" } ]\n    }\n  ],\n  \"total\": 8,\n  \"page\": 1,\n  \"per_page\": 3,\n  \"pages\": 3\n}<\/code><\/pre>\n\n\n\n
    Pagination fields (total<\/code>, page<\/code>, per_page<\/code>, pages<\/code>) sit beside the data array, not inside a wrapper object.<\/p>\n\n\n\n
    Note:<\/strong> memberpress_smart_query<\/code> is a context-fetch tool, not a question-answering one. It returns structured site context \u2014 counts, products, recent revenue \u2014 for the calling AI client to reason over, not a written answer. Its payload shape is { \"question\": \"...\", \"context\": { ... } }<\/code>.<\/p>\n\n\n\n
    Read Tools<\/a><\/h2>\n\n\n\n
    Read tools retrieve data and never change state. They are available on every connection, including read-only Application Password connections. All read tools carry readOnlyHint: true<\/code>, destructiveHint: false<\/code>, idempotentHint: true<\/code>, and require only the read<\/code> scope (always granted).<\/p>\n\n\n\n
    Parameters shown as required<\/strong> must be supplied. List tools share a common pagination pattern: page<\/code> (default 1) and per_page<\/code> (default 20, max 100).<\/p>\n\n\n\n
    Members<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_member<\/code><\/td>Full details for one member, including active subscriptions and accessible memberships.<\/td>identifier<\/code><\/strong> (member ID or email); include_transactions<\/code> (bool, default false)<\/td><\/tr>
    memberpress_list_members<\/code><\/td>List members with filtering. Paginated.<\/td>search<\/code>, status<\/code> (active\/inactive\/all), membership_id<\/code>, page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_export_members<\/code><\/td>Export members as a paginated JSON array.<\/td>membership_id<\/code>, status<\/code>, date_from<\/code>, date_to<\/code>, page<\/code>, per_page<\/code> (default 50)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Memberships<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_membership<\/code><\/td>Full details for a membership\/product: pricing, trial, group, access rules, member count.<\/td>membership_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_memberships<\/code><\/td>List memberships\/products with status filter. Paginated.<\/td>status<\/code> (publish\/draft\/all), page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_get_membership_stats<\/code><\/td>Statistics across all memberships: active subscribers, total revenue, average revenue per member.<\/td>(none)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Subscriptions<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_subscription<\/code><\/td>Full subscription details: user, product, trial status, transaction history.<\/td>subscription_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_subscriptions<\/code><\/td>List subscriptions with filtering. Paginated.<\/td>member_id<\/code>, membership_id<\/code>, status<\/code> (pending\/active\/suspended\/cancelled\/all), date_from<\/code>, date_to<\/code>, page<\/code>, per_page<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Transactions<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_transaction<\/code><\/td>Full transaction details: user, product, subscription, financial data.<\/td>transaction_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_transactions<\/code><\/td>List transactions with filtering. Paginated.<\/td>member_id<\/code>, membership_id<\/code>, subscription_id<\/code>, status<\/code> (pending\/complete\/failed\/refunded\/all), date_from<\/code>, date_to<\/code>, page<\/code>, per_page<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Rules and Access<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_list_rules<\/code><\/td>List access rules with filtering. Paginated.<\/td>membership_id<\/code>, rule_type<\/code>, page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_get_protected_content<\/code><\/td>All protected-content rules and whether a member has access to each.<\/td>member_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_protected_urls<\/code><\/td>List content-protection rules with protected content and required memberships. Paginated.<\/td>page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_check_access<\/code><\/td>Whether a user has access to a specific post\/page.<\/td>user_id<\/code><\/strong>, post_id<\/code><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Coupons<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_list_coupons<\/code><\/td>List coupons with status filter, discount details, usage stats. Paginated.<\/td>status<\/code> (active\/expired\/all), page<\/code>, per_page<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Reports and Analytics<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_revenue_report<\/code><\/td>Revenue for a date range, broken down by period.<\/td>date_from<\/code><\/strong>, date_to<\/code><\/strong>, period<\/code> (daily\/weekly\/monthly\/yearly), membership_id<\/code><\/td><\/tr>
    memberpress_get_churn_report<\/code><\/td>Cancelled\/suspended\/new subscriptions and churn rate for a date range.<\/td>date_from<\/code><\/strong>, date_to<\/code><\/strong>, membership_id<\/code><\/td><\/tr>
    memberpress_revenue_analysis<\/code><\/td>Transaction totals, revenue by product, monthly trends.<\/td>date_from<\/code>, date_to<\/code>, membership_ids<\/code> (array)<\/td><\/tr>
    memberpress_churn_prediction<\/code><\/td>Subscription status counts, cancellation rates, average time before cancel, churn by product.<\/td>membership_id<\/code><\/td><\/tr>
    memberpress_cohort_analysis<\/code><\/td>Signups grouped by month with retention, cancellations, revenue per cohort.<\/td>date_from<\/code>, date_to<\/code><\/td><\/tr>
    memberpress_ltv_analysis<\/code><\/td>Per-subscription revenue and duration grouped by product, for LTV estimation.<\/td>membership_id<\/code><\/td><\/tr>
    memberpress_member_engagement<\/code><\/td>Transaction frequency, subscription status distribution, activity patterns.<\/td>membership_id<\/code>, days<\/code> (max 365, default 90)<\/td><\/tr>
    memberpress_renewal_forecast<\/code><\/td>Upcoming expirations in 30-day buckets with historical renewal rates.<\/td>membership_id<\/code><\/td><\/tr>
    memberpress_failed_payment_analysis<\/code><\/td>Failed and refunded transactions by product, month, gateway, vs. successful volume.<\/td>date_from<\/code>, date_to<\/code><\/td><\/tr>
    memberpress_content_performance<\/code><\/td>Protected-content counts, member-to-content ratios, churn per membership.<\/td>date_from<\/code>, date_to<\/code><\/td><\/tr>
    memberpress_smart_query<\/code><\/td>Site context data for answering a natural-language question about membership data.<\/td>question<\/code><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    When date_from<\/code><\/strong> \/ date_to<\/code><\/strong> are omitted, analytics tools fall back to a default date range rather than requiring explicit dates.<\/p>\n\n\n\n
    System<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_system_info<\/code><\/td>Diagnostics: PHP\/WordPress\/MemberPress versions, active add-ons, payment gateway names, database table status, counts.<\/td>(none)<\/td><\/tr>
    memberpress_list_webhooks<\/code><\/td>List configured webhooks with URLs, events, enabled status.<\/td>(none)<\/td><\/tr>
    memberpress_list_reminders<\/code><\/td>List configured email reminders with trigger events, timing, status, memberships.<\/td>(none)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Courses (requires MemberPress Courses)<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_course<\/code><\/td>Course details: sections, lessons, memberships, completion rate.<\/td>course_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_courses<\/code><\/td>List courses with filtering. Paginated.<\/td>search<\/code>, status<\/code> (publish\/draft\/all), page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_get_lesson<\/code><\/td>Lesson details: section, parent course, availability.<\/td>lesson_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_lessons<\/code><\/td>List lessons filtered by course or section. Paginated.<\/td>course_id<\/code>, section_id<\/code>, page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_get_student_progress<\/code><\/td>A student's per-lesson progress on a course.<\/td>user_id<\/code><\/strong>, course_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_course_students<\/code><\/td>Students enrolled in a course with completion status. Paginated.<\/td>course_id<\/code><\/strong>, page<\/code>, per_page<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Corporate Accounts (requires MemberPress Corporate Accounts)<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_get_corporate_account<\/code><\/td>Corporate account by owner user ID: sub-account usage and list.<\/td>user_id<\/code><\/strong><\/td><\/tr>
    memberpress_list_sub_accounts<\/code><\/td>Sub-accounts for a corporate account. Paginated.<\/td>corporate_account_id<\/code><\/strong>, page<\/code>, per_page<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Downloads (requires MemberPress Downloads)<\/a><\/h3>\n\n\n\n
    Tool<\/th>Purpose<\/th>Key parameters<\/th><\/tr><\/thead>
    memberpress_list_downloads<\/code><\/td>List downloadable files with filtering: title, filename, download count, memberships. Paginated.<\/td>membership_id<\/code>, page<\/code>, per_page<\/code><\/td><\/tr>
    memberpress_get_download_stats<\/code><\/td>Stats for one download: count, file info, memberships, file size.<\/td>file_id<\/code><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Write Tools (Non-Destructive)<\/a><\/h2>\n\n\n\n
    Non-destructive write tools create or update data. Each defaults to a preview<\/strong>: calling it returns what *would* happen without changing anything. To run live, pass execute: true<\/code><\/strong>. Each requires a specific write scope and a WordPress capability. The scope gate runs first and rejects with SCOPE_INSUFFICIENT<\/code>; the capability gate then rejects with CAPABILITY_INSUFFICIENT<\/code>.<\/p>\n\n\n\n
    These tools are not available on read-only connections (including Application Password connections). A connection must be issued the relevant write scope through the wizard at a Full Access ceiling.<\/p>\n\n\n\n
    Some parameters are documented from the inventory below; full input schemas for every write tool still require a Full Access live capture or a per-tool preview (the read-only capture connection could not enumerate write-tool schemas).<\/p>\n\n\n\n
    Tool<\/th>Purpose<\/th>Scope<\/th>Capability<\/th><\/tr><\/thead>
    memberpress_create_member<\/code><\/td>Create a member.<\/td>write:members<\/code><\/td>create_users<\/code><\/td><\/tr>
    memberpress_update_member<\/code><\/td>Update a member. Only the fields the caller sends change; omitted fields are left untouched.<\/td>write:members<\/code><\/td>edit_users<\/code><\/td><\/tr>
    memberpress_create_coupon<\/code><\/td>Create a coupon.<\/td>write:content<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_create_subscription<\/code><\/td>Enroll an existing member in a membership.<\/td>write:members<\/code><\/td>edit_users<\/code><\/td><\/tr>
    memberpress_create_rule<\/code><\/td>Create an access rule.<\/td>write:content<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_create_webhook<\/code><\/td>Create a webhook.<\/td>write:webhooks<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_import_members<\/code><\/td>Bulk-import members.<\/td>write:imports<\/code><\/td>create_users<\/code><\/td><\/tr>
    memberpress_complete_lesson<\/code><\/td>Mark a lesson complete for a student.<\/td>write:courses<\/code><\/td>edit_users<\/code><\/td><\/tr>
    memberpress_toggle_reminder<\/code><\/td>Enable\/disable an email reminder.<\/td>write:webhooks<\/code><\/td>manage_options<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Destructive Tools<\/a><\/h2>\n\n\n\n
    Destructive tools delete, refund, cancel, or reset data. They carry destructiveHint: true<\/code> and cannot<\/strong> be executed with a simple parameter. Each requires the two-step confirmation-token flow<\/strong>: the first call returns a preview plus a single-use confirmation_token<\/code>; a second call passing confirm: \"\"<\/code> with identical arguments runs the operation live. Tokens expire after 60 seconds, are single-use, and are bound to the exact tool, arguments, and user.<\/p>\n\n\n\n
    Reversible actions are exempt from the confirmation gate.<\/strong> Two action values undo rather than destroy, and execute without a token: memberpress_manage_subscription<\/code> with action: \"resume\"<\/code>, and memberpress_manage_sub_account<\/code> with action: \"add\"<\/code>. Every other action on these tools \u2014 and every call to the other four destructive tools \u2014 requires the token flow.<\/p>\n\n\n\n
    Destructive tools are also subject to the kill switch: when destructive writes are paused, every destructive tool is refused with WRITES_PAUSED<\/code>, regardless of scope or a valid token. See the Agent Safety Measures Reference<\/a><\/strong>.<\/p>\n\n\n\n
    Documented parameters appear in the next section; full input schemas still require a Full Access live capture or a per-tool preview.<\/p>\n\n\n\n
    Tool<\/th>Purpose<\/th>Scope<\/th>Capability<\/th><\/tr><\/thead>
    memberpress_delete_member<\/code><\/td>Delete a member (calls wp_delete_user<\/code>; MemberPress cascade-cleans rows, transactions, subscriptions, events). Refuses to delete the calling user or any user with administrator capabilities.<\/td>write:members<\/code><\/td>delete_users<\/code> \u2014 declared as an explicit tool-level gate; the tool is hidden from tools\/list<\/code> for users without it<\/td><\/tr>
    memberpress_delete_webhook<\/code><\/td>Delete a webhook.<\/td>write:webhooks<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_manage_subscription<\/code><\/td>Cancel\/suspend\/resume a subscription.<\/td>write:billing<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_refund_transaction<\/code><\/td>Refund a transaction.<\/td>write:billing<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_manage_sub_account<\/code><\/td>Manage a corporate sub-account.<\/td>write:members<\/code><\/td>manage_options<\/code><\/td><\/tr>
    memberpress_reset_course_progress<\/code><\/td>Reset a student's course progress.<\/td>write:courses<\/code><\/td>edit_users<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Documented Parameters and Behavior<\/a><\/h2>\n\n\n\n
    The following parameter and behavior details are sourced from the codebase inventory and engineering confirmations. They are not a complete schema for every tool; remaining parameters are confirmed by per-tool preview.<\/p>\n\n\n\n