Menu adicional

Obtenha o MemberPress hoje mesmo! Comece a ser pago pelo conteúdo que você cria! Obtenha o MemberPress agora
  1. Início
  2. Base de conhecimento
  3. Documentação para desenvolvedores
  4. MCP
  5. Referência às ferramentas MCP do MemberPress AI Foundation

Referência às ferramentas MCP do MemberPress AI Foundation

O servidor MCP da MemberPress AI Foundation disponibiliza um catálogo de ferramentas que um cliente de IA utiliza para ler e gerenciar dados da MemberPress. Cada ferramenta declara um nome, um esquema de entrada JSON e anotações que a classificam como somente leitura, gravação ou destrutiva.

Esta referência lista todas as ferramentas, agrupadas por domínio, com sua finalidade, parâmetros principais, escopo necessário e capacidade exigida do WordPress. Ela é o complemento do Referência sobre medidas de segurança para agentes, que explica como os escopos, as capacidades e o fluxo de confirmação são aplicados.

Como funciona a lista de ferramentas

Um cliente recupera o catálogo chamando a função ferramentas/lista método no endpoint MCP. Dois fatores determinam quais ferramentas aparecem na resposta:

  1. Nível de acesso à conexão (filtragem de escopo). O servidor retorna apenas as ferramentas permitidas pelo escopo da conexão. Uma conexão somente leitura (incluindo qualquer conexão com senha de aplicativo) tem acesso apenas às ferramentas de leitura. Uma conexão com escopos de gravação tem acesso adicional às ferramentas de gravação e destrutivas abrangidas por seus escopos. Uma ferramenta também fica oculta quando o proprietário do token não possui a capacidade necessária do WordPress — memberpress_delete_member não aparece para um usuário que não tenha excluir_usuários.
  2. Complementos ativos (restrição de acesso a complementos). As ferramentas pertencentes a um complemento são registradas apenas enquanto esse complemento estiver ativo. Um site sem o MemberPress Courses, por exemplo, não exibe as ferramentas do curso.

Devido a esses dois fatores, o número de ferramentas que um site disponibiliza varia. O catálogo é formado por complementos:

RegistroFerramentas autenticadasFerramentas públicas
Versão básica (sem complementos)412
+ Cursos MemberPress+8+2
+ Contas corporativas+3
+ Downloads+2
Tudo ativo54 (39 leituras, 9 gravações não destrutivas, 6 destrutivas)4

Observação: A contagem de ferramentas exibida em uma determinada conexão não é um número fixo. Ela reflete o nível de acesso dessa conexão e os complementos ativos do site. Uma contagem mais baixa é normal e não indica que a instalação esteja com problemas.

Classificações de ferramentas

Cada ferramenta possui anotações que a classificam:

ClassificaçãoAnotaçãoComportamento
LerreadOnlyHint: trueRecupera dados. Nunca altera o estado. Disponível para todas as conexões.
Gravação não destrutivareadOnlyHint: false, destructiveHint: falseCria ou atualiza. Por padrão, exibe uma pré-visualização; passe executar: true para ser transmitido ao vivo.
DestrutivoreadOnlyHint: false, destructiveHint: trueExclui, reembolsa, cancela ou reinicia. Requer o fluxo de confirmação em duas etapas com token.

As mecânicas de gravação e execução destrutiva estão documentadas no Referência sobre medidas de segurança para agentes. Esta referência aborda o que é cada ferramenta e quais dados ela aceita.

Formato de resposta da ferramenta

Um cliente executa uma ferramenta com o ferramentas/chamada método. O resultado é retornado no formato padrão do MCP: um result.content matriz cujo primeiro elemento é um bloco de texto. Esse bloco texto O campo contém os dados da ferramenta como um String JSON o cliente deve analisar. Isso difere do ferramentas/lista forma, que retorna diretamente as definições das ferramentas.

O envelope de um lista_de_membros_do_memberpress chamada:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
 { "type": "text", "text": "{ ...string JSON com caracteres de escape... }" }
    ]
  }
}

Analisando o texto A string retorna a carga útil — uma membros matriz com campos de paginação em linha:

{
  "membros": [
    {
 "id": 50,
 "e-mail": "member@example.com",
 "nome de usuário": "member50",
      "primeiro_nome": "Exemplo",
 "sobrenome": "Membro",
 "data_de_registro": "21/08/2023 17:18:31",
      "active_memberships": [ { "id": 2332, "title": "Associação Básica" } ]
    }
  ],
  "total": 8,
  "página": 1,
  "por_página": 3,
  "páginas": 3
}

Campos de paginação (total, página, por_página, páginas) ficam ao lado da matriz de dados, e não dentro de um objeto envolvent.

Observação: memberpress_smart_query é uma ferramenta de obtenção de contexto, não de resposta a perguntas. Ela retorna contexto estruturado do site — contagens, produtos, receita recente — para que o cliente de IA que a aciona possa fazer raciocínios, e não uma resposta por escrito. O formato de sua carga útil é { "pergunta": "...", "contexto": { ... } }.

Ferramentas de leitura

As ferramentas de leitura recuperam dados e nunca alteram o estado. Elas estão disponíveis em todas as conexões, inclusive nas conexões com senha de aplicativo somente para leitura. Todas as ferramentas de leitura possuem readOnlyHint: true, destructiveHint: false, idempotentHint: true, e exigem apenas o ler âmbito (sempre concedido).

Parâmetros exibidos como necessário deve ser fornecido. As ferramentas de lista compartilham um padrão comum de paginação: página (padrão: 1) e por_página (padrão 20, máximo 100).

Membros

FerramentaObjetivoParâmetros principais
memberpress_get_memberDetalhes completos sobre um membro, incluindo assinaturas ativas e planos de assinatura disponíveis.identificador (ID de membro ou e-mail); incluir_transações (bool, padrão: false)
lista_de_membros_do_memberpressListar membros com filtragem. Paginado.pesquisa, status (ativo/inativo/todos), membership_id, página, por_página
memberpress_export_membersExportar membros como um array JSON paginado.membership_id, status, date_from, date_to, página, por_página (padrão: 50)

Associações

FerramentaObjetivoParâmetros principais
memberpress_get_membershipDetalhes completos sobre uma assinatura/produto: preços, período de teste, grupo, regras de acesso, número de membros.membership_id
lista_de_associações_da_memberpressListar assinaturas/produtos com filtro de status. Paginado.status (publicar/rascunho/todos), página, por_página
memberpress_get_membership_statsEstatísticas gerais sobre todas as assinaturas: assinantes ativos, receita total, receita média por assinante.(nenhum)

Assinaturas

FerramentaObjetivoParâmetros principais
memberpress_get_subscriptionDetalhes completos da assinatura: usuário, produto, status do período de teste, histórico de transações.subscription_id
lista_de_assinaturas_do_memberpressLista de assinaturas com filtragem. Paginada.member_id, membership_id, status (pendente/ativo/suspenso/cancelado/todos), date_from, date_to, página, por_página

Transações

FerramentaObjetivoParâmetros principais
memberpress_get_transactionDetalhes completos da transação: usuário, produto, assinatura, dados financeiros.transaction_id
lista_de_transações_dos_membros_da_imprensaListar transações com filtragem. Paginado.member_id, membership_id, subscription_id, status (pendente/concluído/reprovado/reembolsado/todos), date_from, date_to, página, por_página

Regras e acesso

FerramentaObjetivoParâmetros principais
regras_da_lista_de_membros_da_imprensaLista de regras de acesso com filtragem. Paginada.membership_id, tipo_de_regra, página, por_página
memberpress_get_protected_contentTodas as regras relativas a conteúdo protegido e se um membro tem acesso a cada uma delas.member_id
memberpress_list_protected_urlsLista de regras de proteção de conteúdo com os conteúdos protegidos e as assinaturas exigidas. Paginada.página, por_página
memberpress_check_accessSe um usuário tem acesso a uma postagem/página específica.user_id, post_id

Cupons

FerramentaObjetivoParâmetros principais
lista_de_cupons_para_membrosLista de cupons com filtro de status, detalhes do desconto e estatísticas de uso. Paginada.status (ativas/expiradas/todas), página, por_página

Relatórios e análises

FerramentaObjetivoParâmetros principais
memberpress_get_revenue_reportReceita para um intervalo de datas, detalhada por período.date_from, date_to, período (diário/semanal/mensal/anual), membership_id
memberpress_get_churn_reportAssinaturas canceladas/suspensas/novas e taxa de cancelamento para um intervalo de datas.date_from, date_to, membership_id
análise_de_receitas_do_memberpressTotais de transações, receita por produto, tendências mensais.date_from, date_to, IDs de membros (matriz)
memberpress_previsão_de_rotatividadeNúmero de assinaturas ativas, taxas de cancelamento, tempo médio até o cancelamento, rotatividade por produto.membership_id
análise_de_coorte_do_memberpressInscrições agrupadas por mês, com taxas de retenção, cancelamentos e receita por coorte.date_from, date_to
memberpress_ltv_análiseReceita por assinatura e duração agrupadas por produto, para estimativa do LTV.membership_id
memberpress_engajamento_dos_membrosFrequência das transações, distribuição do status das assinaturas, padrões de atividade.membership_id, dias (máximo 365, padrão 90)
previsão_de_renovação_do_memberpressVencimentos futuros em intervalos de 30 dias, com taxas históricas de renovação.membership_id
análise_de_pagamentos_não_concluídos_do_memberpressTransações com falha e reembolsadas por produto, mês e gateway, em comparação com o volume de transações bem-sucedidas.date_from, date_to
memberpress_content_performanceNúmero de conteúdos protegidos, proporção entre membros e conteúdos, taxa de cancelamento por assinatura.date_from, date_to
memberpress_smart_queryDados de contexto do site para responder a uma pergunta em linguagem natural sobre dados de filiação.pergunta

Quando date_from / date_to se forem omitidas, as ferramentas de análise utilizam um intervalo de datas padrão, em vez de exigir datas explícitas.

Sistema

FerramentaObjetivoParâmetros principais
memberpress_get_system_infoDiagnósticos: versões do PHP/WordPress/MemberPress, complementos ativos, nomes dos gateways de pagamento, status das tabelas do banco de dados, contagens.(nenhum)
memberpress_list_webhooksListar os webhooks configurados com URLs, eventos e status de ativação.(nenhum)
lista_de_lembretes_para_membrosListar os lembretes por e-mail configurados, com eventos desencadeadores, intervalos de tempo, status e associações.(nenhum)

Cursos (exige cursos com 1 aula teórica e 6 aulas práticas)

FerramentaObjetivoParâmetros principais
memberpress_get_courseDetalhes do curso: seções, aulas, inscrições, taxa de conclusão.course_id
lista_de_cursos_para_membrosListar cursos com filtragem. Paginado.pesquisa, status (publicar/rascunho/todos), página, por_página
memberpress_get_lessonDetalhes da aula: seção, curso principal, disponibilidade.ID da lição
lista_de_aulas_para_membrosListar aulas filtradas por curso ou turma. Com paginação.course_id, section_id, página, por_página
memberpress_get_student_progressO progresso de um aluno por aula em um curso.user_id, course_id
lista_de_alunos_do_curso_memberpressAlunos matriculados em um curso com status de conclusão. Paginado.course_id, página, por_página

Contas corporativas (requer o módulo MemberPress Contas corporativas)

FerramentaObjetivoParâmetros principais
memberpress_get_corporate_accountConta corporativa por ID de usuário do titular: uso e lista de subcontas.user_id
lista_de_subcontas_de_membrosSubcontas de uma conta corporativa. Paginado.id_da_conta_corporativa, página, por_página

Downloads (requer o MemberPress Downloads)

FerramentaObjetivoParâmetros principais
lista_de_downloads_dos_membrosLista de arquivos disponíveis para download com filtros: título, nome do arquivo, número de downloads, assinaturas. Paginada.membership_id, página, por_página
memberpress_get_download_statsEstatísticas de um download: contagem, informações do arquivo, assinaturas, tamanho do arquivo.id_do_arquivo

Ferramentas de gravação (não destrutivas)

As ferramentas de gravação não destrutivas criam ou atualizam dados. Cada uma delas usa, por padrão, um visualização: ao chamá-la, ela retorna o que *aconteceria* sem alterar nada. Para executar em tempo real, passe executar: true. Cada uma delas requer um escopo de gravação específico e uma capacidade do WordPress. A verificação de escopo é executada primeiro e rejeita com SCOPE_INSUFICIENTE; o mecanismo de verificação de capacidade, então, rejeita com CAPACIDADE_INSUFICIENTE.

Essas ferramentas não estão disponíveis em conexões somente leitura (incluindo conexões com senha de aplicativo). É necessário atribuir à conexão o escopo de gravação relevante por meio do assistente, com o nível máximo de acesso total.

Alguns parâmetros estão documentados no inventário abaixo; os esquemas completos de entrada para cada ferramenta de gravação ainda exigem uma captura em tempo real com acesso total ou uma visualização específica para cada ferramenta (a conexão de captura somente para leitura não conseguiu enumerar os esquemas das ferramentas de gravação).

FerramentaObjetivoEscopoCapacidade
memberpress_create_memberCrie um membro.escrever:membroscreate_users
memberpress_update_memberAtualizar um membro. Apenas os campos enviados pelo chamador são alterados; os campos omitidos permanecem inalterados.escrever:membroseditar_usuários
memberpress_create_couponCrie um cupom.escrever:conteúdogerenciar_opções
memberpress_create_subscriptionInscrever um associado já cadastrado em um plano de associação.escrever:membroseditar_usuários
memberpress_create_ruleCrie uma regra de acesso.escrever:conteúdogerenciar_opções
memberpress_create_webhookCrie um webhook.escrever:webhooksgerenciar_opções
memberpress_import_membersImportar membros em massa.escrever:importaçõescreate_users
memberpress_lição_concluídaMarcar uma aula como concluída para um aluno.escrever:cursoseditar_usuários
memberpress_toggle_reminderAtivar/desativar um lembrete por e-mail.escrever:webhooksgerenciar_opções

Ferramentas destrutivas

As ferramentas destrutivas excluem, reembolsam, cancelam ou reinicializam dados. Elas envolvem destructiveHint: true e não pode ser executado com um único parâmetro. Cada um deles requer o fluxo de token de confirmação em duas etapas: a primeira chamada retorna uma pré-visualização e um código de uso único token_de_confirmação; uma segunda chamada que passa confirmar: "" com argumentos idênticos, executa a operação em tempo real. Os tokens expiram após 60 segundos, são de uso único e estão vinculados à ferramenta, aos argumentos e ao usuário específicos.

As ações reversíveis estão isentas da etapa de confirmação. Dois valores de ação que revertem, em vez de destruir, e são executados sem um token: memberpress_gerenciar_assinatura com ação: "retomar"e memberpress_gerenciar_subconta com ação: "adicionar". Qualquer outra ação nessas ferramentas — e qualquer chamada às outras quatro ferramentas destrutivas — requer o fluxo de tokens.

As ferramentas destrutivas também estão sujeitas ao kill switch: quando as gravações destrutivas são pausadas, todas as ferramentas destrutivas são rejeitadas com WRITES_PAUSED, independentemente do escopo ou de um token válido. Consulte o Referência sobre medidas de segurança para agentes.

Os parâmetros documentados constam na próxima seção; os esquemas completos de entrada ainda exigem uma captura em tempo real com acesso total ou uma visualização por ferramenta.

FerramentaObjetivoEscopoCapacidade
memberpress_delete_memberExcluir um membro (chamadas wp_delete_user; MemberPress realiza limpeza em cascata de linhas, transações, assinaturas e eventos). Recusa-se a excluir o usuário que fez a chamada ou qualquer usuário com o gerenciar_opções capacidade (administradores, superadministradores e qualquer função personalizada à qual essa capacidade tenha sido concedida). Ambas as verificações são executadas antes da execução e antes do ramo de pré-visualização; portanto, até mesmo uma pré-visualização é recusada.escrever:membrosexcluir_usuários — declarado como um portão explícito no nível da ferramenta; a ferramenta fica oculta de ferramentas/lista para usuários que não o possuem
memberpress_delete_webhookExcluir um webhook.escrever:webhooksgerenciar_opções
memberpress_gerenciar_assinaturaCancelar/suspender/retomar uma assinatura.escrever:faturamentogerenciar_opções
transação de reembolso do MemberPressReembolsar uma transação.escrever:faturamentogerenciar_opções
memberpress_gerenciar_subcontaGerenciar uma subconta corporativa.escrever:membrosgerenciar_opções
memberpress_reset_course_progressRedefinir o andamento do aluno no curso.escrever:cursoseditar_usuários

Parâmetros e comportamento documentados

Os detalhes a seguir sobre parâmetros e comportamentos foram extraídos do inventário do código-fonte e de confirmações da equipe de engenharia. Eles não constituem um esquema completo para todas as ferramentas; os parâmetros restantes são confirmados por meio da visualização prévia de cada ferramenta.

  • memberpress_create_coupontipo de desconto{porcentagem, dólar}, discount_mode{padrão, primeiro pagamento} (padrão padrão), além de discount_amount e um opcional IDs de membros matriz (restringe o cupom a produtos específicos). Valores legados (plano, primeiro, todos) são rejeitados categoricamente. Aceita executar.
  • memberpress_create_subscription — inscreve um membro *existente* em uma assinatura (é necessário ter membro + produto); recusa inscrições duplicadas; sempre usa gateway='manual' (acesso concedido pela administração, não se trata de um evento de cobrança); filiais que comercializam produtos de uso único versus produtos recorrentes. Oferece executar.
  • memberpress_import_members — aceita um nível superior enviar_e-mail_de_boas-vindas booleano (padrão falso); o e-mail de boas-vindas do WordPress é enviado uma vez para cada membro recém-criado após o provisionamento. Os usuários existentes cujos endereços de e-mail coincidirem não são recriados. Contém executar.
  • memberpress_delete_membermember_id; chamadas wp_delete_user, permitindo que o MemberPress usuário_excluído gancho para limpar em cascata as linhas relacionadas. Apenas no fluxo de token de confirmação.
  • memberpress_gerenciar_assinatura — um seletor de ações que abrange cancelar/suspender/retomar; currículo é uma variante não destrutiva que ignora a porta destrutiva. Fluxo de tokens de confirmação para ações destrutivas.
  • memberpress_gerenciar_subconta — um seletor de ação; adicionar é uma variante não destrutiva que ignora a porta destrutiva.
  • transação de reembolso do MemberPresstransaction_id obrigatório; opcional cancelar_assinatura booleano. Efeito colateral da resposta: quando a transação tiver uma assinatura associada E cancelar_assinatura *não* foi aprovado, a resposta (pré-visualização e ao vivo) acrescenta a_lista_de_assinaturas_pode_exibir_contas_inativas: true e um nota_sobre_a_lista_de_assinaturas. Essa marcação e essa nota referem-se a apenas como a lista de assinaturas do painel de administração do WP exibe o status — essa coluna é derivada do status da transação mais recente, e não do registro da assinatura — e são ignoradas quando cancel_subscription: true. O sinalizador não descreve o comportamento de acesso: o reembolso da última transação associada a uma assinatura encerra o acesso do membro para aquele período. Esse formato de resposta deve constar em qualquer exemplo de reembolso. Apenas no fluxo de token de confirmação.

Ferramentas públicas

O endpoint público não autenticado (/wp-json/mp-mcp/v1/public-mcp) apresenta um conjunto separado e cuidadosamente selecionado de 4 ferramentas somente para leitura para uso sem um token. Elas retornam apenas dados públicos do catálogo — preços e links de inscrição — e nunca dados de membros, transações ou de administração. Todas as quatro são memberpress_-prefixado e transportado readOnlyHint: true.

Esses quatro nomes também existem na superfície de leitura autenticada, mas as versões públicas são distintas: esquemas mais simples, descrições específicas para o público e resultados limitados aos itens incluídos no catálogo público.

FerramentaObjetivoParâmetros principais
lista_de_associações_da_memberpressListe os planos de assinatura disponíveis ao público, incluindo preços e links para inscrição.(nenhum)
memberpress_get_membershipDetalhes sobre um plano de assinatura público: preços, informações sobre o período de teste e URL para inscrição.membership_id
lista_de_cursos_para_membrosListar os cursos disponíveis ao público.(nenhum)
memberpress_get_courseDetalhes de um curso aberto ao público: visão geral e número de aulas.course_id

O catálogo público é configurado em dois níveis: um administrador o habilita globalmente (Configurações do MCP → “Habilitar endpoint do catálogo público de IA”, padrão desligado), e cada assinatura ou curso pode ser excluído individualmente desmarcando a caixa de seleção “Exibir no catálogo público de IA” na tela de edição. A obter_associação/get_course A consulta a um item que não consta no catálogo público não retorna nenhum dado.

Observação: Quando o catálogo público está desativado (configuração padrão), a rota do endpoint não é montada; portanto, qualquer solicitação retorna HTTP 404 rest_no_route — a existência do ponto final não é revelada. O /.well-known/mcp.json O documento de descoberta funciona da mesma maneira.

Controle de portas de complemento

As ferramentas de complementos são registradas apenas enquanto o respectivo complemento estiver ativo, o que é detectado por uma sonda que verifica a classe principal do complemento:

ComplementoClasse de detecçãoFerramentas
Cursosmemberpress\courses\models\Courseferramentas do curso/aula
Contas corporativasMPCA_Conta_Corporativaferramentas corporativas
Downloadsmemberpress\downloads\models\Arquivoferramentas para download

Um site que não possui um complemento simplesmente não expõe suas ferramentas — chamar uma ferramenta não registrada retorna o erro padrão de método desconhecido do JSON-RPC.

Observação: O MemberPress Gifting é não integrado com o AI Foundation — nenhuma ferramenta de presentes é registrada, independentemente de o complemento “Gifting” estar ativo ou não. O suporte ao “Gifting” está previsto para uma versão futura.

Referência do escopo

O assistente emite conexões com um ou mais escopos. O acesso de leitura é sempre concedido; os escopos de gravação são concedidos apenas com o limite máximo de “Acesso Total”.

Mapa das caixas de seleção da etapa “Acesso” do assistente individual para esses escopos — o valor de cada caixa de seleção é a string interna do escopo, armazenada literalmente no token:

Balde do MagoEscopo publicado
Leia tudoler (sempre concedido)
Editar conteúdoescrever:conteúdo
Gerenciar membrosescrever:membros
Operações de faturamentoescrever:faturamento
Importações em grande volumeescrever:importações
Gerenciar webhooksescrever:webhooks
Progresso no cursoescrever:cursos

Não há um escopo específico para cupons, lembretes ou operações corporativas — os cupons fazem parte de escrever:conteúdo, lembretes por e-mail em escrever:webhooks, e subcontas corporativas em escrever:membros.

EscopoSubsídios
lerTodas as ferramentas de leitura. Sempre concedidas.
escrever:membrosFerramentas para criar/atualizar/excluir membros.
escrever:faturamentoFerramentas de gerenciamento de assinaturas e reembolso de transações.
escrever:conteúdoFerramentas de regras de acesso e cupons.
escrever:webhooksFerramentas de criação/exclusão de webhooks e lembretes por e-mail.
escrever:importaçõesFerramenta de importação de membros.
escrever:cursosFerramentas de acompanhamento do andamento do curso. São exibidas no assistente somente quando a opção “Cursos” estiver ativa.
completoMetascópio legado. Satisfaz qualquer escreva:* solicitação. Mantida por motivos de compatibilidade com versões anteriores.

Referência de Recursos

Além do escopo, cada ferramenta de gravação verifica se o proprietário do token possui a capacidade correspondente no WordPress. Um token com o escopo correto, mas cujo proprietário não possua a capacidade, é rejeitado com CAPACIDADE_INSUFICIENTE.

CapacidadeFerramentas
create_userscreate_member, import_members
editar_usuáriosatualizar_membro, criar_assinatura, lição_completa, reiniciar_o_progresso_do_curso
excluir_usuáriosexcluir_membro — porta explícita no nível da ferramenta; oculta de ferramentas/lista sem isso
gerenciar_opçõesgerenciar_assinatura, transação_de_reembolso, create_rule, criar_cupom, create_webhook, excluir_webhook, alternar_lembrete, gerenciar_subconta
Este artigo foi útil?

Artigos relacionados

garota do computador

Obtenha o MemberPress hoje mesmo!

Comece a ser pago pelo conteúdo que você cria.