Vitally

Accede a los datos de clientes desde la API de Vitally.

Documentación

Servidor MCP de Vitally

Un servidor MCP (Model Context Protocol) que proporciona acceso a los datos de clientes de Vitally a través de la API de Vitally.

Contenedorizado

Si necesitas una versión contenedorizada, consulta github.com/fiscaltec/vitally-mcp

Características

  • Listar cuentas de clientes como recursos
  • Leer detalles de cuentas
  • Buscar usuarios por correo electrónico o ID externo
  • Encontrar cuentas por nombre
  • Consultar puntuaciones de salud de cuentas
  • Ver conversaciones y tareas de cuentas
  • Crear notas para cuentas
  • Buscar entre las herramientas disponibles
  • Modo demo con datos simulados cuando no se proporciona una clave de API

Configuración

  1. Instalar dependencias:

    npm install
    
  2. Crear un archivo .env en el directorio raíz con lo siguiente:

    # Vitally API Configuration
    VITALLY_API_SUBDOMAIN=nylas  # Your Vitally subdomain
    VITALLY_API_KEY=your_api_key_here  # Your Vitally API key
    VITALLY_DATA_CENTER=US  # or EU depending on your data center
    
  3. Compilar el proyecto:

    npm run build
    

Nota: Si aún no tienes una clave de API de Vitally, el servidor se ejecutará en modo demo con datos simulados.

Obtener tu clave de API de Vitally

  1. Navega a tu cuenta de Vitally
  2. Ve a Configuración (⚙️) > Integraciones > REST API
  3. Activa el interruptor para habilitar la integración
  4. Copia la clave de API

Uso

Hay dos formas de usar este servidor MCP:

Usando el MCP Inspector

Ejecuta el MCP Inspector para probar y depurar el servidor:

npm run inspector

Esto abrirá la interfaz del MCP Inspector donde podrás interactuar con tu servidor.

Conectar a Claude Desktop

  1. Primero, encuentra tu archivo de configuración de Claude Desktop:

    • En macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • En Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Edita el archivo de configuración para añadir el servidor MCP de Vitally:

    {
      "mcpServers": {
        "vitally-api": {
          "command": "node",
          "args": ["--experimental-modules", "--experimental-specifier-resolution=node", "/Users/johnjung/nylas/vitally/vitally/build/index.js"]
        }
      }
    }
    
  3. Reinicia Claude Desktop y podrás usar el servidor MCP de Vitally.

Herramientas disponibles

Descubrimiento de herramientas

  • search_tools - Buscar herramientas disponibles por palabra clave

Gestión de cuentas

  • search_accounts - Buscar cuentas usando múltiples criterios (nombre, externalId)
  • find_account_by_name - Encontrar cuentas por su nombre (se admite coincidencia parcial)
  • refresh_accounts - Actualizar la lista de cuentas en caché
  • get_account_health - Obtener puntuaciones de salud para una cuenta específica

Gestión de usuarios

  • search_users - Buscar usuarios por correo electrónico, ID externo o subdominio de correo

Comunicación y tareas

  • get_account_conversations - Obtener conversaciones recientes de una cuenta
  • get_account_tasks - Obtener tareas de una cuenta (se puede filtrar por estado)
  • create_account_note - Crear una nueva nota para una cuenta

Preguntas de ejemplo para hacer

Cuando estés conectado a un cliente MCP como Claude, puedes hacer preguntas como:

  • "Lista todos nuestros clientes"
  • "Encuentra cuentas con 'Acme' en su nombre"
  • "¿Cuál es la puntuación de salud de la cuenta X?"
  • "Encuentra al usuario con el correo example@company.com"
  • "Muéstrame detalles sobre el cliente Y"
  • "Obtén conversaciones recientes de la cuenta Z"
  • "¿Qué tareas están abiertas para la cuenta A?"
  • "Añade una nota a la cuenta B sobre nuestra llamada reciente"
  • "¿Qué herramientas puedo usar para la gestión de cuentas?"

Solución de problemas

  • Si encuentras errores de análisis JSON, asegúrate de haber eliminado todas las declaraciones console.log del código
  • Asegúrate de que tu archivo .env contenga las credenciales de API correctas
  • Verifica que hayas compilado el proyecto (npm run build) después de hacer cambios
  • Verifica que la ruta en claude_desktop_config.json sea absoluta y correcta para tu sistema
  • Si no tienes una clave de API válida, el servidor se ejecutará en modo demo con datos simulados