chrome-devtools-frontend/front_end/models/ai_assistance/tools/GetSourceContent.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 Common from '../../../core/common/common.js';
import * as Host from '../../../core/host/host.js';
import * as i18n from '../../../core/i18n/i18n.js';
import * as TextUtils from '../../../core/text_utils/text_utils.js';
import {FileFormatter} from '../data_formatters/FileFormatter.js';

import {ListSourcesTool} from './ListSources.js';
import {
  type BaseToolCapability,
  type DataHandlerResult,
  type DataTool,
  type OriginLockCapability,
  type ToolArgs,
  ToolName,
} from './Tool.js';

const UIStringsNotTranslate = {
  readingSource: 'Reading source content',
} as const;

const lockedString = i18n.i18n.lockedString;

export interface GetSourceContentArgs extends ToolArgs {
  id: number;
}

/**
 * A tool that retrieves the contents of a source file by its unique ID.
 * Filters access by origin lock to prevent cross-origin leakage.
 */
export class GetSourceContentTool implements
    DataTool<GetSourceContentArgs, {content: string}, BaseToolCapability&OriginLockCapability> {
  readonly name = ToolName.GET_SOURCE_CONTENT;
  readonly description = 'Gets the content and metadata of a source file by its ID.';

  readonly parameters: Host.AidaClient.FunctionObjectParam<keyof GetSourceContentArgs> = {
    type: Host.AidaClient.ParametersTypes.OBJECT,
    description: '',
    properties: {
      id: {
        type: Host.AidaClient.ParametersTypes.INTEGER,
        description: 'The unique numeric ID of the source file to retrieve.',
        nullable: false,
      },
    },
    required: ['id'],
  };

  displayInfoFromArgs(args: GetSourceContentArgs): {
    title: string,
    action: string,
  } {
    return {
      title: lockedString(UIStringsNotTranslate.readingSource),
      action: `getSourceContent(${args.id})`,
    };
  }

  async handler(
      args: GetSourceContentArgs,
      context: BaseToolCapability&OriginLockCapability,
      ): Promise<DataHandlerResult<{content: string}>> {
    const origin = context.getEstablishedOrigin();
    const file = ListSourcesTool.getUISourceCodes().find(
        f => ListSourcesTool.uiSourceCodeId.get(f) === args.id,
    );

    if (!file) {
      return {
        error: 'Unable to find file.',
      };
    }

    const fileUrl = file.url();
    const fileOrigin = Common.ParsedURL.ParsedURL.extractOrigin(fileUrl);
    if (origin && fileOrigin !== origin) {
      return {
        error: 'Cross-origin access blocked.',
      };
    }

    const contentData = await file.requestContentData();
    if (TextUtils.ContentData.ContentData.isError(contentData)) {
      return {
        error: `Failed to load file content: ${contentData.error}`,
      };
    }

    const formatter = new FileFormatter(file);

    return {
      result: {
        content: formatter.formatFile(),
      },
    };
  }
}