chrome-devtools-frontend/front_end/models/ai_assistance/tools/ListCookies.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 * as i18n from '../../../core/i18n/i18n.js';
import * as SDK from '../../../core/sdk/sdk.js';

import {getCookiesForOrigin, resolveAllowedTargetOrigins} from './CookieUtils.js';
import {
  type BaseToolCapability,
  type DataHandlerResult,
  type DataTool,
  type OriginLockCapability,
  type ServerLoggingCapability,
  ToolAnnotation,
  type ToolArgs,
  ToolName,
} from './Tool.js';

const lockedString = i18n.i18n.lockedString;

export interface ListCookiesArgs extends ToolArgs {
  origins?: string[];
}

export interface ListCookiesResult {
  cookieNamesByOrigin: Record<string, {cookies: string[]}|{error: string}>;
}

export class ListCookiesTool implements
    DataTool<ListCookiesArgs, ListCookiesResult, BaseToolCapability&OriginLockCapability&ServerLoggingCapability> {
  readonly name: ToolName = ToolName.LIST_COOKIES;
  readonly description: string =
      'Lists all cookie names for requested origins (or the current page origin if omitted), strictly excluding their values.';

  readonly annotations: ToolAnnotation[] = [ToolAnnotation.REDACT_FROM_HISTORY];

  readonly parameters: Host.AidaClient.FunctionObjectParam<keyof ListCookiesArgs> = {
    type: Host.AidaClient.ParametersTypes.OBJECT,
    description: '',
    nullable: false,
    properties: {
      origins: {
        type: Host.AidaClient.ParametersTypes.ARRAY,
        description: 'Optional list of origins to list cookies for. Defaults to the current page origin if omitted.',
        items: {type: Host.AidaClient.ParametersTypes.STRING, description: 'An origin URL.'},
        nullable: true,
      },
    },
    required: [],
  };

  displayInfoFromArgs(args: ListCookiesArgs): {
    title: string,
    action: string,
  } {
    return {
      title: lockedString('Reading cookies'),
      action: `listCookies(${JSON.stringify(args?.origins ?? [])})`,
    };
  }

  async handler(
      args: ListCookiesArgs,
      context: BaseToolCapability&OriginLockCapability&ServerLoggingCapability,
      ): Promise<DataHandlerResult<ListCookiesResult>> {
    context.disableLogging();

    // eslint-disable-next-line @devtools/no-instance-of-migrated-singletons
    const targetManager = SDK.TargetManager.TargetManager.instance();
    const targetOriginsResult = resolveAllowedTargetOrigins(args?.origins, context, targetManager);
    if ('error' in targetOriginsResult) {
      return {error: targetOriginsResult.error};
    }
    const {targetOrigins, primaryPageTarget} = targetOriginsResult;

    const cookieNamesByOrigin: ListCookiesResult['cookieNamesByOrigin'] = {};

    await Promise.all(targetOrigins.map(async origin => {
      const result = await getCookiesForOrigin(origin, targetManager, primaryPageTarget);
      if ('error' in result) {
        cookieNamesByOrigin[origin] = {error: result.error};
        return;
      }

      const uniqueNames = Array.from(new Set(result.cookies.map(c => c.name())));
      cookieNamesByOrigin[origin] = {cookies: uniqueNames};
    }));

    return {result: {cookieNamesByOrigin}};
  }
}