Wordware

Ejecuta tus aplicaciones de Wordware localmente con una configuración interactiva.

GitHubPrueba este MCPPatrocinado

Documentación

wordware-mcp

El servidor MCP (Model Context Protocol) de Wordware te permite ejecutar tus aplicaciones de Wordware localmente. Esto te permite integrar los potentes flujos de IA de Wordware directamente en tu entorno de desarrollo local, facilitando la prueba y el desarrollo de aplicaciones que aprovechan las capacidades de Wordware.

Novedades en la Versión 1.1.5

  • Actualizado para funcionar con el nuevo endpoint de API local (http://localhost:9000/{WORDWARE_API_TOKEN})
  • Ya no es necesario especificar APP_IDs: las herramientas se descubren automáticamente
  • Proceso de instalación interactivo con npx wordware-mcp
  • Configuración automática de Claude
  • Interfaz CLI mejorada con soporte de argumentos de línea de comandos
  • Especificación directa de la clave de API mediante parámetros
  • Mejor manejo de errores y registro de actividades
  • Soporte de instalación global con sintaxis de comando simple

Instalación

La forma más fácil de comenzar es usando el proceso de instalación interactivo con npx:

npx wordware-mcp

Esto te guiará a través de:

  1. Ingresar tu clave de API de Wordware
  2. Configurar Claude (opcional)

El comando npx:

  • Te solicitará los detalles de configuración si no se proporcionan
  • Creará los archivos de configuración necesarios
  • Configurará tu entorno local para ejecutar aplicaciones de Wordware

Después de ejecutar el comando npx, puedes iniciar el servidor MCP con:

npx wordware-mcp

Instalación Permanente

Si prefieres instalar el paquete de forma permanente:

# 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

Requisitos Previos

Antes de usar este paquete, necesitas:

  1. Una cuenta de Wordware (regístrate en wordware.ai)
  2. Una clave de API de Wordware
  3. Al menos una aplicación de Wordware implementada

Uso Básico

Usando npx directamente (sin necesidad de instalación)

Puedes ejecutar wordware-mcp usando npx sin instalarlo primero:

# 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

Si está instalado globalmente, puedes ejecutarlo de una de dos maneras:

# 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

Opciones de Línea de Comandos

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 paquete en tu proyecto

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

// Start the MCP server
startMCP();

Configuración

Puedes configurar el servidor MCP de dos maneras:

1. Variables de Entorno o Archivo .env

Crea un archivo .env con las siguientes variables:

WORDWARE_API_KEY=your-api-key
PORT=3000

2. Argumentos de Línea de Comandos

Pasa la configuración directamente al ejecutar el comando:

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

Creando Tu Configuración de Wordware

Crear una cuenta

Para comenzar, necesitarás una cuenta de Wordware. Ve a wordware.ai, inicia sesión y crea una cuenta.

Crear una clave de API

Para que tus flujos de wordware sean accesibles a través de MCP, necesitarás crear una clave de API. Para ello, haz clic en tu foto de perfil en la esquina superior derecha > Claves de API > Crear una nueva clave > Copia tu clave.

Crear una aplicación

Ahora es el momento de ser creativo. Crea una aplicación de wordware para lo que quieras lograr, o siéntete libre de bifurcar una aplicación desde la página de exploración (https://app.wordware.ai/explore).

Implementar tu aplicación

Para que tu aplicación se active como MCP, necesitarás implementarla. Para ello, ve a tu aplicación. Deberías ver un botón "Implementar" en la esquina superior derecha. Luego ve a la página de implementación.

Obtener el app_id

En la página de implementación, verás tu URL de implementación: https://app.wordware.ai/explore/apps/{app_id}. Obtén tu app_id desde allí.

Uso con Claude Desktop

Para usar este servidor MCP con Claude Desktop:

  1. Asegúrate de que Claude para Desktop esté instalado

  2. Modifica el archivo de configuración de Claude Desktop ubicado en: ~/Library/Application\ Support/Claude/claude_desktop_config.json

  3. Agrega lo siguiente al archivo:

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

Ejemplo Completo de Flujo de Trabajo

Aquí tienes un ejemplo completo de flujo de trabajo para ponerte en marcha rápidamente:

1. Configurar e Iniciar 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. Integrar con Tu Aplicación

Después de iniciar el servidor MCP, tus aplicaciones de Wordware serán accesibles en:

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

Puedes activar tus flujos de Wordware mediante solicitudes 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. Desarrollo con Recarga Automática

Durante el desarrollo, cualquier cambio que realices en tus aplicaciones de Wordware estará disponible de inmediato: solo actualiza tu aplicación o realiza una nueva llamada a la API.

Desarrollo

Si deseas contribuir a este paquete:

# 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

Licencia

MIT

Solución de Problemas

Problemas Comunes con npx

  1. "Comando no encontrado" después de la instalación

    Si ves command not found después de instalar con 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 configuración

    Si tu configuración no se está detectando:

    # 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. Errores de conexión rechazada

    Si ves errores de conexión al intentar usar tus aplicaciones:

    # Check if server is running
lsof -i :3000

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

  4. Problemas de permisos

    Si encuentras errores de permisos con 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 más ayuda, por favor reporta un problema en nuestro repositorio de GitHub.

Variables de Entorno

Las siguientes variables de entorno se pueden configurar en el archivo .env:

  • PORT - El puerto en el que se ejecutará el servidor (predeterminado: 3000)
  • WORDWARE_API_KEY - Tu clave de API de Wordware