Detalhes do Projeto WordPress MCP

Visão Geral do Projeto

O WordPress MCP (Model Context Protocol) é um plugin WordPress desenvolvido pela Automattic, projetado para transformar um site WordPress em um servidor MCP simples. Ele expõe as funcionalidades do site através da WordPress REST API, permitindo que grandes modelos de linguagem (LLMs) e agentes de IA interajam com ele. Este projeto permite que desenvolvedores utilizem ferramentas de IA para automatizar tarefas como gerenciamento de conteúdo, operações de usuário, configuração do site, etc., aumentando a eficiência do desenvolvimento e a capacidade de integração.

Funcionalidades Principais

1. Suporte ao Servidor MCP:

   • Fornece funcionalidade de servidor MCP através de rotas REST API (como /wp/v2/wpmcp e /wp/v2/wpmcp/streamable), suportando a interação de agentes de IA com o WordPress.
   • Suporta duas camadas de transporte: McpStdioTransport (entrada e saída padrão) e McpStreamableTransport (transmissão em fluxo, adequada para SSE ou outros protocolos de fluxo).

2. Mecanismo de Autenticação:

   • Adota um sistema de autenticação JWT (JSON Web Token) para garantir a comunicação segura.
   • Suporta senhas de aplicativos WordPress (Application Passwords) e chaves de consumidor e segredos da WooCommerce REST API, aumentando a segurança.

3. Processadores de Métodos:

   • Fornece processadores de métodos como Ferramentas (Tools), Recursos (Resources) e Prompts (Prompts), suportando gerenciamento de conteúdo, inicialização do site e outras operações.
   • A funcionalidade pode ser estendida através de ferramentas personalizadas para atender a necessidades específicas.

4. Interface de Gerenciamento:

   • Fornece uma interface de gerenciamento baseada em React, facilitando aos usuários o gerenciamento de tokens de autenticação (Tokens) e outras configurações no painel de administração do WordPress.

5. Compatibilidade com Clientes MCP:

   • Colabora perfeitamente com clientes compatíveis com MCP (como o Claude Desktop), suportando solicitações REST API através de um proxy (como mcp-wordpress-remote) sem a necessidade de manter uma conexão sempre aberta.

Características do Projeto

• Segurança: Garante a segurança dos dados através da autenticação JWT e senhas de aplicativos, com a recomendação de usar comunicação criptografada HTTPS.
• Extensibilidade: Suporta desenvolvedores na expansão da funcionalidade do plugin adicionando ferramentas, recursos e prompts personalizados.
• Amigável ao Desenvolvimento: Fornece documentação de teste detalhada (tests/README.md) e um guia de contribuição, incentivando a participação da comunidade no desenvolvimento.
• Leve e Eficiente: O modo proxy evita conexões sempre abertas, otimizando o desempenho e tornando-o adequado para desenvolvimento local e implantação remota.
• Licença de Código Aberto: Adota a licença GPL v2 ou superior, aberta para as comunidades WordPress e AI.

Arquitetura Técnica

A arquitetura central do projeto inclui os seguintes módulos:

• Camada de Transporte (Transport Layer):

  • McpStdioTransport: Processa solicitações MCP através de entrada e saída padrão, adequado para desenvolvimento local.
  • McpStreamableTransport: Suporta transmissão em fluxo, adequado para cenários de interação em tempo real (atualmente, alguns clientes podem não suportar).

• Sistema de Autenticação (Authentication):

  • Usa autenticação JWT, requer a definição de WPMCP_JWT_SECRET_KEY em wp-config.php.
  • Suporta senhas de aplicativos WordPress e chaves WooCommerce, aumentando a flexibilidade.

• Processadores de Métodos (Method Handlers):

  • Ferramentas (Tools): Implementa operações de criação, atualização, exclusão, etc., de conteúdo.
  • Recursos (Resources): Fornece interfaces de acesso a dados do site.
  • Prompts (Prompts): Fornece orientação contextual para agentes de IA.
  • Inicialização do Sistema (System & Initialization): Lida com a inicialização e configuração do servidor MCP.

• Interface de Gerenciamento (Admin Interface):

  • Construída usando React, localizada na página "Configurações > WordPress MCP" no painel de administração do WordPress, usada para gerenciar tokens de autenticação e interruptores de recursos.

Instalação e Configuração

Etapas de Instalação

1. Clonar o Repositório:

   cd wp-content/plugins/
   git clone https://github.com/Automattic/wordpress-mcp.git
   cd wordpress-mcp
   

2. Instalar Dependências:

   composer install --no-dev
   npm install && npm run build
   

3. Ativar o Plugin:

   • Ative o plugin WordPress MCP na página "Plugins" no painel de administração do WordPress.

4. Configurar a Funcionalidade MCP:

   • Navegue até "Configurações > WordPress MCP", ative a funcionalidade MCP e configure os tokens de autenticação.

5. Configurar a Chave JWT: Adicione em wp-config.php:

   define('WPMCP_JWT_SECRET_KEY', 'your-secret-key');
   define('WPMCP_DEBUG', true); // Enable debug logging
   

6. Instalar o Cliente Remoto (Opcional):

   • Para usar com mcp-wordpress-remote, instale usando o seguinte comando:

     npx @modelcontextprotocol/inspector \
     -e WP_API_URL=https://your-site.com/ \
     -e JWT_TOKEN=your-jwt-token-here \
     npx @automattic/mcp-wordpress-remote@latest
     

Notas de Configuração

• Segurança: Nunca envie tokens de autenticação para o sistema de controle de versão, certifique-se de que WPMCP_JWT_SECRET_KEY seja armazenado com segurança.
• Depuração: Ativar WPMCP_DEBUG pode registrar logs de depuração, facilitando a solução de problemas.
• Operações de Exclusão: Excluir ferramentas pode causar perda permanente de dados, ative apenas para usuários confiáveis.
• Dependência do Cliente Remoto: O plugin WordPress MCP precisa ser usado com mcp-wordpress-remote para realizar a funcionalidade completa.

Casos de Uso

O projeto WordPress MCP é adequado para os seguintes cenários:

1. Gerenciamento Automatizado de Conteúdo:

   • Crie, atualize ou exclua artigos, páginas, usuários, etc., através de agentes de IA, economizando tempo de operação manual.
   • Exemplo: Use o comando "Criar 10 rascunhos de artigos com o título 'Artigo de teste #1–10'" no Claude Desktop para gerar automaticamente conteúdo de teste.

2. Desenvolvimento e Teste:

   • Os desenvolvedores podem usar ferramentas MCP para gerar rapidamente dados de teste, acelerando o teste de funcionalidade e o desenvolvimento de integração.
   • Exemplo: Consulte logs de depuração e resuma problemas através de agentes de IA, simplificando o processo de depuração.

3. Gerenciamento do Site:

   • Gerencie remotamente a configuração do site, permissões de usuário ou arquivos de mídia, adequado para colaboração em equipe distribuída.
   • Suporta integração com WooCommerce, pode gerenciar dados relacionados ao comércio eletrônico (como pedidos, produtos).

4. Personalização Orientada por IA:

   • Os desenvolvedores podem adicionar ferramentas personalizadas, expondo lógica de negócios específica para atender a necessidades personalizadas.
   • Exemplo: Crie ferramentas personalizadas para atualizar categorias de artigos em lote ou otimizar metadados SEO.

Extensão e Desenvolvimento

Adicionar Ferramentas Personalizadas

Os desenvolvedores podem estender a funcionalidade do plugin seguindo estas etapas:

1. Criar Arquivo de Ferramenta:

   • Adicione uma nova classe de ferramenta no diretório wp-content/plugins/wordpress-mcp/includes/Tools/.
   • Exemplo de classe de ferramenta:

     <?php
     namespace WPMCP\Tools;
     class CustomTool {
         public function execute($params) {
             // Implementar lógica personalizada
             return ['success' => true, 'data' => 'Custom tool executed'];
         }
     }
     

2. Registrar Ferramenta:

   • Registre a nova ferramenta durante a inicialização do plugin, garantindo que ela esteja disponível através da interface MCP.

3. Referenciar Implementações Existentes:

   • Consulte o código de exemplo nos diretórios includes/Tools/, includes/Resources/ e includes/Prompts/.

Contribuir com Código

• Guia de Contribuição: Consulte as Diretrizes de Contribuição no repositório, envie Pull Requests ou relate Issues.
• Documentação de Teste: Consulte tests/README.md para entender o processo de teste e garantir a qualidade do código.
• Requisitos de Licença: Todas as contribuições devem seguir a licença GPL v2 ou superior.

Recursos Relacionados

• Repositório GitHub: https://github.com/Automattic/wordpress-mcp
• Cliente Remoto: https://github.com/Automattic/mcp-wordpress-remote
• Site Oficial do WordPress MCP: https://mcp-wp.github.io