simstudioai--sim/apps/sim/tools/github/list_pr_comments.ts

import { truncate } from '@sim/utils/string'
import type { CommentsListResponse, ListPRCommentsParams } from '@/tools/github/types'
import { PR_COMMENT_OUTPUT_PROPERTIES, USER_OUTPUT } from '@/tools/github/types'
import type { ToolConfig } from '@/tools/types'

export const listPRCommentsTool: ToolConfig<ListPRCommentsParams, CommentsListResponse> = {
  id: 'github_list_pr_comments',
  name: 'GitHub PR Review Comments Lister',
  description: 'List all review comments on a GitHub pull request',
  version: '1.0.0',

  params: {
    owner: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'Repository owner',
    },
    repo: {
      type: 'string',
      required: true,
      visibility: 'user-or-llm',
      description: 'Repository name',
    },
    pullNumber: {
      type: 'number',
      required: true,
      visibility: 'user-or-llm',
      description: 'Pull request number',
    },
    sort: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Sort by created or updated',
      default: 'created',
    },
    direction: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Sort direction (asc or desc)',
      default: 'desc',
    },
    since: {
      type: 'string',
      required: false,
      visibility: 'user-or-llm',
      description: 'Only show comments updated after this ISO 8601 timestamp',
    },
    per_page: {
      type: 'number',
      required: false,
      visibility: 'user-or-llm',
      description: 'Number of results per page (max 100)',
      default: 30,
    },
    page: {
      type: 'number',
      required: false,
      visibility: 'user-or-llm',
      description: 'Page number',
      default: 1,
    },
    apiKey: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'GitHub API token',
    },
  },

  request: {
    url: (params) => {
      const baseUrl = `https://api.github.com/repos/${params.owner}/${params.repo}/pulls/${params.pullNumber}/comments`
      const queryParams = new URLSearchParams()

      if (params.sort) queryParams.append('sort', params.sort)
      if (params.direction) queryParams.append('direction', params.direction)
      if (params.since) queryParams.append('since', params.since)
      if (params.per_page) queryParams.append('per_page', Number(params.per_page).toString())
      if (params.page) queryParams.append('page', Number(params.page).toString())

      const query = queryParams.toString()
      return query ? `${baseUrl}?${query}` : baseUrl
    },
    method: 'GET',
    headers: (params) => ({
      Accept: 'application/vnd.github+json',
      Authorization: `Bearer ${params.apiKey}`,
      'X-GitHub-Api-Version': '2022-11-28',
    }),
  },

  transformResponse: async (response) => {
    const data = await response.json()

    const content = `Found ${data.length} review comment${data.length !== 1 ? 's' : ''} on PR #${response.url.split('/').slice(-2, -1)[0]}${
      data.length > 0
        ? `\n\nRecent review comments:\n${data
            .slice(0, 5)
            .map(
              (c: any) =>
                `- ${c.user.login} on ${c.path}${c.line ? `:${c.line}` : ''} (${new Date(c.created_at).toLocaleDateString()}): "${truncate(c.body, 80)}"`
            )
            .join('\n')}`
        : ''
    }`

    return {
      success: true,
      output: {
        content,
        metadata: {
          comments: data.map((comment: any) => ({
            id: comment.id,
            body: comment.body,
            user: { login: comment.user.login },
            created_at: comment.created_at,
            html_url: comment.html_url,
          })),
          total_count: data.length,
        },
      },
    }
  },

  outputs: {
    content: { type: 'string', description: 'Human-readable review comments summary' },
    metadata: {
      type: 'object',
      description: 'Review comments list metadata',
      properties: {
        comments: {
          type: 'array',
          description: 'Array of review comment objects',
          items: {
            type: 'object',
            properties: {
              id: { type: 'number', description: 'Comment ID' },
              body: { type: 'string', description: 'Comment body' },
              user: {
                type: 'object',
                description: 'User who created the comment',
                properties: {
                  login: { type: 'string', description: 'User login' },
                },
              },
              created_at: { type: 'string', description: 'Creation timestamp' },
              html_url: { type: 'string', description: 'GitHub web URL' },
            },
          },
        },
        total_count: { type: 'number', description: 'Total number of review comments' },
      },
    },
  },
}

export const listPRCommentsV2Tool: ToolConfig<ListPRCommentsParams, any> = {
  id: 'github_list_pr_comments_v2',
  name: listPRCommentsTool.name,
  description: listPRCommentsTool.description,
  version: '2.0.0',
  params: listPRCommentsTool.params,
  request: listPRCommentsTool.request,

  transformResponse: async (response: Response) => {
    const comments = await response.json()
    return {
      success: true,
      output: {
        items: comments ?? [],
        count: comments?.length ?? 0,
      },
    }
  },

  outputs: {
    items: {
      type: 'array',
      description: 'Array of review comment objects',
      items: {
        type: 'object',
        properties: {
          ...PR_COMMENT_OUTPUT_PROPERTIES,
          user: USER_OUTPUT,
        },
      },
    },
    count: { type: 'number', description: 'Number of comments returned' },
  },
}