Skip to content

Latest commit

 

History

History
314 lines (241 loc) · 9.69 KB

File metadata and controls

314 lines (241 loc) · 9.69 KB

Spec Workflow MCP

npm version VSCode Extension

Un servidor Model Context Protocol (MCP) para desarrollo estructurado basado en especificaciones con panel de control en tiempo real y extensión para VSCode.

☕ Apoya Este Proyecto

Buy Me A Coffee

📺 Demostración

🔄 Sistema de Aprobación en Acción

Approval System Demo

Mira cómo funciona el sistema de aprobación: crea documentos, solicita aprobación a través del panel de control, proporciona retroalimentación y rastrea revisiones.

📊 Panel de Control y Gestión de Especificaciones

Dashboard Demo

Explora el panel de control en tiempo real: visualiza especificaciones, rastrea el progreso, navega documentos y monitorea tu flujo de trabajo de desarrollo.

✨ Características Principales

  • Flujo de Trabajo de Desarrollo Estructurado - Creación secuencial de especificaciones (Requisitos → Diseño → Tareas)
  • Panel de Control Web en Tiempo Real - Monitorea especificaciones, tareas y progreso con actualizaciones en vivo
  • Extensión para VSCode - Experiencia integrada con panel lateral para usuarios de VSCode
  • Flujo de Trabajo de Aprobación - Proceso completo de aprobación con revisiones
  • Seguimiento de Progreso de Tareas - Barras de progreso visuales y estado detallado
  • Registros de Implementación - Registros con búsqueda de todas las implementaciones de tareas con estadísticas de código
  • Soporte Multiidioma - Disponible en 11 idiomas

🌍 Idiomas Compatibles

🇺🇸 English • 🇯🇵 日本語 • 🇨🇳 中文 • 🇪🇸 Español • 🇧🇷 Português • 🇩🇪 Deutsch • 🇫🇷 Français • 🇷🇺 Русский • 🇮🇹 Italiano • 🇰🇷 한국어 • 🇸🇦 العربية

🚀 Inicio Rápido

Paso 1: Agregar a tu herramienta de IA

Agrega a tu configuración MCP (ver configuración específica del cliente a continuación):

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}

Paso 2: Elige tu interfaz

Opción A: Panel de Control Web (Requerido para usuarios de CLI) Inicia el panel de control (se ejecuta en el puerto 5000 por defecto):

npx -y @pimzino/spec-workflow-mcp@latest --dashboard

El panel de control estará accesible en: http://localhost:5000

Nota: Solo se necesita una instancia del panel de control. Todos tus proyectos se conectarán al mismo panel.

Opción B: Extensión para VSCode (Recomendado para usuarios de VSCode)

Instala Spec Workflow MCP Extension desde el marketplace de VSCode.

📝 Cómo Usar

Simplemente menciona spec-workflow en tu conversación:

  • "Crea una especificación para autenticación de usuarios" - Crea un flujo de trabajo de especificación completo
  • "Lista mis especificaciones" - Muestra todas las especificaciones y su estado
  • "Ejecuta la tarea 1.2 en la especificación user-auth" - Ejecuta una tarea específica

Ver más ejemplos →

🔧 Configuración del Cliente MCP

Augment Code

Configura en tu configuración de Augment:

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}
Claude Code CLI

Agrega a tu configuración MCP:

claude mcp add spec-workflow npx @pimzino/spec-workflow-mcp@latest -- /ruta/a/tu/proyecto

Notas Importantes:

  • La bandera -y omite las solicitudes de npm para una instalación más fluida
  • El separador -- asegura que la ruta se pase al script spec-workflow, no a npx
  • Reemplaza /ruta/a/tu/proyecto con la ruta real del directorio de tu proyecto

Alternativa para Windows (si lo anterior no funciona):

claude mcp add spec-workflow cmd.exe /c "npx @pimzino/spec-workflow-mcp@latest /ruta/a/tu/proyecto"
Claude Desktop

Agrega a claude_desktop_config.json:

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}

Importante: Ejecuta el panel de control por separado con --dashboard antes de iniciar el servidor MCP.

Cline/Claude Dev

Agrega a tu configuración del servidor MCP:

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}
Continue IDE Extension

Agrega a tu configuración de Continue:

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}
Cursor IDE

Agrega a tu configuración de Cursor (settings.json):

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}
OpenCode

Agrega a tu archivo de configuración opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "spec-workflow": {
      "type": "local",
      "command": ["npx", "-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"],
      "enabled": true
    }
  }
}
Windsurf

Agrega a tu archivo de configuración ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]
    }
  }
}
Codex

Agrega a tu archivo de configuración ~/.codex/config.toml:

[mcp_servers.spec-workflow]
command = "npx"
args = ["-y", "@pimzino/spec-workflow-mcp@latest", "/ruta/a/tu/proyecto"]

🐳 Despliegue con Docker

Ejecuta el panel de control en un contenedor Docker para un despliegue aislado:

# Usando Docker Compose (recomendado)
cd containers
docker-compose up --build

# O usando Docker CLI
docker build -f containers/Dockerfile -t spec-workflow-mcp .
docker run -p 5000:5000 -v "./workspace/.spec-workflow:/workspace/.spec-workflow:rw" spec-workflow-mcp

El panel de control estará disponible en: http://localhost:5000

Ver guía de configuración de Docker →

🔒 Entornos en Sandbox

Para entornos en sandbox (por ejemplo, Codex CLI con sandbox_mode=workspace-write) donde $HOME es de solo lectura, usa la variable de entorno SPEC_WORKFLOW_HOME para redirigir los archivos de estado global a una ubicación con permisos de escritura:

SPEC_WORKFLOW_HOME=/workspace/.spec-workflow-mcp npx -y @pimzino/spec-workflow-mcp@latest /workspace

Ver Guía de Configuración →

📚 Documentación

📁 Estructura del Proyecto

tu-proyecto/
  .spec-workflow/
    approvals/
    archive/
    specs/
    steering/
    templates/
    user-templates/
    config.example.toml

🛠️ Desarrollo

# Instalar dependencias
npm install

# Construir el proyecto
npm run build

# Ejecutar en modo desarrollo
npm run dev

Ver guía de desarrollo →

📄 Licencia

GPL-3.0

⭐ Historial de Estrellas

Star History Chart