Skip to content

Deep Research

Deep research assistant for issue comments with web fetch.

Workflow source: gh-aw-deep-research.md

How it works

Activated by a comment on an issue (the example trigger uses /research). The workflow investigates local code and external sources, then posts an evidence-backed response. It is strictly read-only and does not execute repository commands or implement changes.

Quick Install

mkdir -p .github/workflows && curl -sL \
  https://raw.githubusercontent.com/elastic/ai-github-actions/v0/gh-agent-workflows/deep-research/example.yml \
  -o .github/workflows/deep-research.yml

Trigger

Event Types Condition
issue_comment created Comment on an issue (not a PR); the example trigger filters on /research prefix

Inputs

Input Description Required Default
additional-instructions Repo-specific instructions appended to the agent prompt No ""
allowed-bot-users Allowlisted bot actor usernames (comma-separated) No github-actions[bot]

Required secret

  • GEMINI_API_KEY — API key for Gemini engine authentication.

Safe Outputs

  • add-comment — reply to the issue with research findings

Example Workflow

name: Deep Research
on:
  issue_comment:
    types: [created]

permissions:
  actions: read
  contents: read
  discussions: write
  issues: write
  pull-requests: read

jobs:
  run:
    if: >-
      github.event.issue.pull_request == null &&
      startsWith(github.event.comment.body, '/research')
    uses: elastic/ai-github-actions/.github/workflows/gh-aw-deep-research.lock.yml@v0
    secrets:
      GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}