Wordware

Execute seus aplicativos Wordware localmente com uma configuração interativa.

GitHubExperimente este MCPPatrocinado

Documentação

wordware-mcp

O servidor Wordware MCP (Model Context Protocol) permite que você execute seus aplicativos Wordware localmente. Isso possibilita integrar os poderosos fluxos de IA da Wordware diretamente no seu ambiente de desenvolvimento local, facilitando o teste e o desenvolvimento de aplicações que aproveitam os recursos da Wordware.

Novidades na Versão 1.1.5

  • Atualizado para funcionar com o novo endpoint de API local (http://localhost:9000/{WORDWARE_API_TOKEN})
  • Não é mais necessário especificar APP_IDs - as ferramentas são descobertas automaticamente
  • Processo de instalação interativo com npx wordware-mcp
  • Configuração automática do Claude
  • Interface CLI aprimorada com suporte a argumentos de linha de comando
  • Especificação direta da chave de API via parâmetros
  • Tratamento de erros e registro de logs aprimorados
  • Suporte a instalação global com sintaxe de comando simples

Instalação

A maneira mais fácil de começar é usar o processo de instalação interativo com npx:

npx wordware-mcp

Isso irá guiá-lo através de:

  1. Inserir sua chave de API da Wordware
  2. Configurar o Claude (opcional)

O comando npx irá:

  • Solicitar detalhes de configuração se não forem fornecidos
  • Criar os arquivos de configuração necessários
  • Configurar seu ambiente local para executar aplicativos Wordware

Após executar o comando npx, você pode iniciar o servidor MCP com:

npx wordware-mcp

Instalação Permanente

Se você preferir instalar o pacote permanentemente:

# Install globally from npm registry
npm install -g wordware-mcp

# Or install locally in your project
npm install wordware-mcp

# Or clone this repository and install globally
git clone https://github.com/{username}/wordware-mcp.git
cd wordware-mcp
npm run install-global

Pré-requisitos

Antes de usar este pacote, você precisa de:

  1. Uma conta Wordware (cadastre-se em wordware.ai)
  2. Uma chave de API da Wordware
  3. Pelo menos um aplicativo Wordware implantado

Uso Básico

Usando npx diretamente (sem necessidade de instalação)

Você pode executar o wordware-mcp usando npx sem instalá-lo primeiro:

# Interactive mode - will prompt for required information
npx wordware-mcp

# Or with command line parameters
npx wordware-mcp --api-key your-api-key --port 3000

# Start MCP server after configuration
npx wordware-mcp start

Como comando global

Se instalado globalmente, você pode executar de duas maneiras:

# Option 1: Create an .env file in your current directory first (see Configuration section)
wordware-mcp

# Option 2: Pass parameters directly via command line
wordware-mcp --api-key your-api-key --port 3000

Opções de Linha de Comando

Options:
  --api-key, -k <key>      Wordware API key (required unless in .env file)
  --port, -p <port>        Port to run the server on (default: 3000)
  --help, -h               Show this help message

Como pacote no seu projeto

// In your script
import { startMCP } from "wordware-mcp";

// Start the MCP server
startMCP();

Configuração

Você pode configurar o servidor MCP de duas maneiras:

1. Variáveis de Ambiente ou Arquivo .env

Crie um arquivo .env com as seguintes variáveis:

WORDWARE_API_KEY=your-api-key
PORT=3000

2. Argumentos de Linha de Comando

Passe a configuração diretamente ao executar o comando:

wordware-mcp -k your-api-key -p 3000

Criando Sua Configuração Wordware

Criar uma conta

Para começar, você precisará de uma conta Wordware. Acesse wordware.ai, entre e crie uma conta

Criar uma chave de API

Para que seus fluxos Wordware sejam acessíveis via MCP, você precisará criar uma chave de API. Para isso, clique na sua foto de perfil no canto superior direito > API keys > Create a new key > Copie sua chave

Criar um aplicativo

Agora é hora de ser criativo. Crie um aplicativo Wordware para o que você quiser alcançar, ou sinta-se à vontade para fazer fork de um aplicativo da página de exploração (https://app.wordware.ai/explore).

Implantar seu aplicativo

Para que seu aplicativo seja acionado como MCP, você precisará implantá-lo. Para isso, acesse seu aplicativo. Você deve ver um botão "Deploy" no canto superior direito. Em seguida, acesse a página de implantação.

Obtenha o app_id

Na página de implantação, você verá sua URL de implantação: https://app.wordware.ai/explore/apps/{app_id}. Obtenha seu app_id a partir daí

Usando com Claude Desktop

Para usar este servidor MCP com Claude Desktop:

  1. Certifique-se de que o Claude for Desktop esteja instalado

  2. Modifique o arquivo de configuração do Claude Desktop localizado em: ~/Library/Application\ Support/Claude/claude_desktop_config.json

  3. Adicione o seguinte ao arquivo:

{
  "mcpServers": {
    "wordware": {
      "command": "wordware-mcp"
    }
  }
}

Exemplo Completo de Fluxo de Trabalho

Aqui está um exemplo completo de fluxo de trabalho para começar rapidamente:

1. Configure e Inicie o Wordware MCP

# Run the interactive setup
npx wordware-mcp

# Follow the prompts to:
# - Enter your Wordware API key
# - Configure Claude integration (if desired)

# Once configured, start the server
npx wordware-mcp start

2. Integre com Sua Aplicação

Após iniciar o servidor MCP, seus aplicativos Wordware estarão acessíveis em:

http://localhost:3000/api/run/{app_id}

Você pode acionar seus fluxos Wordware via requisições HTTP:

// Example: Calling your Wordware app from JavaScript
async function callWordwareApp() {
  const response = await fetch("http://localhost:3000/api/run/your-app-id", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      // Your input data here
      prompt: "Your prompt to the AI model",
      // Any other parameters your Wordware app expects
    }),
  });

  const result = await response.json();
  console.log(result);
}

3. Desenvolvendo com Hot Reloading

Durante o desenvolvimento, quaisquer alterações que você fizer em seus aplicativos Wordware estarão imediatamente disponíveis - basta atualizar seu aplicativo ou fazer uma nova chamada de API.

Desenvolvimento

Se você quiser contribuir com este pacote:

# Clone the repository
git clone https://github.com/yuhuangou/wordware-mcp.git
cd wordware-mcp

# Install dependencies
npm install

# Build the package
npm run build

# Run in development mode
npm run dev

Licença

MIT

Solução de Problemas

Problemas Comuns com npx

  1. "Comando não encontrado" após a instalação

    Se você vir command not found após instalar com npx:

    # Make sure the package is installed globally
npm install -g wordware-mcp

# Check your npm global path is in your PATH
npm config get prefix
# Add the resulting path + /bin to your PATH if needed

  2. Problemas de configuração

    Se sua configuração não está sendo detectada:

    # Check if .env file exists in current directory
ls -la .env

# Manually run with parameters to bypass .env
npx wordware-mcp --api-key your-api-key

  3. Erros de conexão recusada

    Se você vir erros de conexão ao tentar usar seus aplicativos:

    # Check if server is running
lsof -i :3000

# Restart server with verbose logging
npx wordware-mcp start --verbose

  4. Problemas de permissão

    Se você encontrar erros de permissão com npx:

    # Run with sudo (not recommended as permanent solution)
sudo npx wordware-mcp

# Fix npm permissions
chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}

Para obter mais assistência, por favor, abra uma issue em nosso repositório GitHub.

Variáveis de Ambiente

As seguintes variáveis de ambiente podem ser definidas no arquivo .env:

  • PORT - A porta para executar o servidor (padrão: 3000)
  • WORDWARE_API_KEY - Sua chave de API da Wordware