Wordware MCP

by yuhuangou
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Supports configuration via .env files, allowing users to specify environment variables like API keys and port settings for the Wordware MCP server.

  • Provides access to the source code repository for contribution and development of the Wordware MCP server.

  • Enables installation and execution of the Wordware MCP server through npm packages and the npx command.

software de palabras-mcp

El servidor MCP (Programa de Control Maestro) de Wordware le permite ejecutar sus aplicaciones de Wordware localmente. Esto le permite integrar los potentes flujos de IA de Wordware directamente en su entorno de desarrollo local, facilitando la prueba y el desarrollo de aplicaciones que aprovechan las capacidades de Wordware.

Novedades de la versión 1.1.5

  • Actualizado para funcionar con el nuevo punto final de API local ( http://localhost:9000/{WORDWARE\_API\_TOKEN} )
  • Ya no es necesario especificar APP_ID: 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 API mediante parámetros
  • Manejo y registro de errores mejorados
  • Soporte de instalación global con sintaxis de comandos sencilla

Instalación

La forma más sencilla de comenzar es utilizar el proceso de instalación interactivo con npx:

npx wordware-mcp

Esto le guiará a través de:

  1. Ingresando su clave API de Wordware
  2. Configuración de Claude (opcional)

El comando npx hará lo siguiente:

  • Le solicitará detalles de configuración si no los proporciona
  • Crear los archivos de configuración necesarios
  • Configure su entorno local para ejecutar aplicaciones de Wordware

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

npx wordware-mcp

Instalación permanente

Si prefiere 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/yuhuangou/wordware-mcp.git cd wordware-mcp npm run install-global

Prerrequisitos

Antes de utilizar este paquete, necesitas:

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

Uso básico

Usando npx directamente (no requiere 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 se instala globalmente, se puede ejecutar 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 su proyecto

// In your script import { startMCP } from "wordware-mcp"; // Start the MCP server startMCP();

Configuración

Puede 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 la línea de comandos

Pase la configuración directamente al ejecutar el comando:

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

Creando su configuración de Wordware

Crear una cuenta

Para empezar, necesitarás una cuenta de Wordware. Visita wordware.ai , inicia sesión y crea una cuenta.

Crear una clave API

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

Crear una aplicación

Ahora es momento de ser creativo. Crea una aplicación de Wordware para lo que quieras lograr o crea una bifurcación desde la página de exploración ( https://app.wordware.ai/explore ).

Implementa tu aplicación

Para que tu aplicación se active como MCP, debes implementarla. Para ello, ve a tu aplicación. Deberías ver el 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 la URL de implementación: https://app.wordware.ai/explore/apps/{app_id} . Obtén tu app_id desde ahí.

Uso con Claude Desktop

Para utilizar este servidor MCP con Claude Desktop:

  1. Asegúrese de que Claude for Desktop esté instalado
  2. Modifique el archivo de configuración del escritorio de Claude ubicado en: ~/Library/Application\ Support/Claude/claude_desktop_config.json
  3. Añade lo siguiente al archivo:
{ "mcpServers": { "wordware": { "command": "wordware-mcp" } } }

Ejemplo completo de flujo de trabajo

A continuación se muestra un ejemplo de flujo de trabajo completo para comenzar a trabajar 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. Integración con su aplicación

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

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

Puede activar sus flujos de Wordware a través de 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 en caliente

Durante el desarrollo, cualquier cambio que realice en sus aplicaciones de Wordware estará disponible de inmediato: solo actualice su aplicación o realice 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

Instituto Tecnológico de Massachusetts (MIT)

Solución de problemas

Problemas comunes con npx

  1. "Comando no encontrado" después de la instalaciónSi ve que 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ónSi no se detecta su configuración:
    # 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 rechazadaSi ve errores de conexión al intentar usar sus aplicaciones:
    # Check if server is running lsof -i :3000 # Restart server with verbose logging npx wordware-mcp start --verbose
  4. Problemas de permisosSi encuentra 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 obtener más ayuda, envíe 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 donde se ejecutará el servidor (predeterminado: 3000)
  • WORDWARE_API_KEY - Su clave API de Wordware
ID: ocjz66huw2