Saltearse al contenido
Nappai Documentation

Jira Reader

El Jira Reader es un componente que te permite extraer información de Jira Cloud, como issues, usuarios, proyectos y más. Con él, tu flujo de trabajo puede consultar datos en tiempo real y usar esos resultados como entradas para otras tareas o como herramientas que el agente de IA puede seleccionar.

¿Cómo funciona?

El componente se conecta a la API de Jira Cloud usando la credencial Jira API (email y token). Cuando seleccionas una operación, envía una solicitud HTTP al endpoint correspondiente y devuelve la respuesta en un formato estructurado. Si activas el modo de mapeo, puedes procesar varios registros a la vez y usar valores fijos, mapeados o calculados con JavaScript para cada campo.

Operaciones

Este componente ofrece varias operaciones que puedes seleccionar según lo que necesites hacer. Solo puedes usar una operación a la vez:

  • List Issues: Obtiene una lista de issues de Jira, opcionalmente filtrados por proyecto.
  • List Users: Recupera la lista de usuarios disponibles en tu instancia de Jira.
  • List Projects: Devuelve todos los proyectos que tienes en Jira.
  • List Issue Types: Muestra los tipos de issue (Bug, Task, etc.) disponibles.
  • List Priorities: Lista las prioridades configuradas en Jira.
  • List Statuses: Obtiene los estados de los issues.

Para usar el componente, primero selecciona la operación que necesitas en el campo “Operation” (Operación).

Entradas

Modo de Mapeo (Mapping Mode)

Este componente cuenta con un modo especial llamado “Mapping Mode” (Modo de Mapeo). Cuando activas este modo mediante el interruptor, se habilita una entrada adicional llamada “Mapping Data” y cada campo de entrada te ofrece tres formas diferentes de proporcionar datos:

  • Fixed (Fijo): Escribes el valor directamente en el campo.
  • Mapped (Mapeado): Conectas la salida de otro componente para usar su resultado como valor.
  • Javascript: Escribes código Javascript para calcular el valor dinámicamente.

Esta flexibilidad te permite crear flujos de trabajo más dinámicos y conectados.

Campos de Entrada

Los siguientes campos están disponibles para configurar este componente. Cada campo puede estar visible en diferentes operaciones:

  • Operation: Selecciona la acción que quieres ejecutar.

    • Visible en: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Issue Type: Tipo de issue, por ejemplo, Task, Bug, Subtask.

    • Visible en: List Priorities

  • Mapping Mode: Habilita el modo de mapeo para procesar múltiples registros en lote.

    • Visible en: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Project Key: Clave del proyecto para filtrar issues.

    • Visible en: List Issues, List Users, List Issue Types, List Priorities, List Statuses

  • Tool Name: Nombre de la herramienta que se mostrará al agente cuando el componente se conecte como herramienta.

    • Visible en: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Tool Description: Descripción detallada de lo que hace esta herramienta.

    • Visible en: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Tools arguments metadata: Define los metadatos de los argumentos de la herramienta.

    • Visible en: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Credential: Selecciona la credencial Jira API previamente configurada.

    • Visible en: Todas las operaciones

Nota: Antes de usar el componente, debes:

  1. Configurar la credencial Jira API en la sección de credenciales de Nappai.
  2. Seleccionar esa credencial en el campo “Credential” del componente.

Salidas

  • Jira Response: La respuesta de la API de Jira, disponible como datos que pueden ser usados en pasos posteriores.
  • Tool: Una herramienta que el agente puede invocar, con los parámetros definidos por los campos anteriores.

Ejemplo de Uso

Supongamos que quieres que tu agente obtenga la lista de issues de un proyecto llamado PROJ y luego los use para generar un informe.

  1. Añade el componente Jira Reader al flujo.
  2. Selecciona la operación List Issues.
  3. En Project Key, elige PROJ (o escribe la clave si no aparece en la lista).
  4. Configura Tool Name como “Jira Issues List” y añade una breve descripción.
  5. Conecta la salida Jira Response a un componente de procesamiento de datos o a un generador de texto.
  6. Si quieres procesar varios proyectos a la vez, activa Mapping Mode y conecta la entrada Project Key a la salida de otro componente que genere las claves de proyecto.

El agente podrá entonces usar la herramienta “Jira Issues List” para solicitar la lista de issues cuando lo necesite.

Componentes Relacionados

  • Jira Base Reader: Base que provee la lógica común para leer datos de Jira.
  • Jira Writer (si existe): Permite crear o actualizar issues en Jira.

Consejos y Mejores Prácticas

  • Limita la cantidad de datos: Si tu proyecto tiene miles de issues, considera usar filtros adicionales (por ejemplo, por fecha o estado) para evitar respuestas muy grandes.
  • Usa el modo de mapeo cuando necesites procesar varios proyectos o tipos de issue en un solo flujo.
  • Define nombres claros para las herramientas (Tool Name) para que el agente las reconozca fácilmente.
  • Revisa los permisos de la credencial Jira API; solo otorga los permisos necesarios (lectura de issues, usuarios, etc.).

Consideraciones de Seguridad

  • La credencial Jira API almacena tu token de API; manténla segura y evita compartirla.
  • Asegúrate de que la cuenta de Jira usada tenga permisos mínimos necesarios para las operaciones que vas a realizar.
  • Si compartes el flujo con otros usuarios, revisa que no se expongan datos sensibles en las salidas.