chrome-devtools-frontend/front_end/models/ai_assistance/tools/GetLighthouseAudits.ts

Chrome DevTools UI

// Copyright 2026 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import * as Host from '../../../core/host/host.js';
import type * as LHModel from '../../lighthouse/lighthouse.js';
import type {FunctionCallHandlerResult} from '../agents/AiAgent.js';
import {AccessibilityContext} from '../contexts/AccessibilityContext.js';
import {LighthouseFormatter} from '../data_formatters/LighthouseFormatter.js';

import {type BaseToolCapability, type Tool, type ToolArgs, ToolName} from './Tool.js';

export interface GetLighthouseAuditsArgs extends ToolArgs {
  categoryId: LHModel.RunTypes.CategoryId;
}

export class GetLighthouseAuditsTool implements Tool<GetLighthouseAuditsArgs, {audits: string}, BaseToolCapability> {
  readonly name = ToolName.GET_LIGHTHOUSE_AUDITS;
  readonly description = 'Returns the audits for a specific Lighthouse category.';

  readonly parameters: Host.AidaClient.FunctionObjectParam<keyof GetLighthouseAuditsArgs> = {
    type: Host.AidaClient.ParametersTypes.OBJECT,
    description: 'Arguments for retrieving Lighthouse category audits.',
    nullable: false,
    properties: {
      categoryId: {
        type: Host.AidaClient.ParametersTypes.STRING,
        description: 'The category of audits to retrieve. E.g. "accessibility".',
        nullable: false,
      },
    },
    required: ['categoryId'],
  };

  displayInfoFromArgs(params: GetLighthouseAuditsArgs): {title: string, action: string} {
    return {
      title: `Getting Lighthouse audits for ${params.categoryId}`,
      action: `getLighthouseAudits('${params.categoryId}')`,
    };
  }

  async handler(params: GetLighthouseAuditsArgs,
                context: BaseToolCapability): Promise<FunctionCallHandlerResult<{audits: string}>> {
    if (!(context.conversationContext instanceof AccessibilityContext)) {
      return {error: 'Error: Active context is not a Lighthouse report.'};
    }
    const report = context.conversationContext.getItem();
    const audits = new LighthouseFormatter().audits(report, params.categoryId);
    return {
      result: {audits},
      widgets: [{name: 'LIGHTHOUSE_REPORT', data: {report}}],
    };
  }
}