Files
sim/apps/sim/tools/sentry/issues_get.ts
Waleed 6cb3977dd9 fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm (#3095)
* fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm

* update docs

* updated docs script
2026-01-31 11:31:08 -08:00

171 lines
6.4 KiB
TypeScript

import type { SentryGetIssueParams, SentryGetIssueResponse } from '@/tools/sentry/types'
import type { ToolConfig } from '@/tools/types'
export const getIssueTool: ToolConfig<SentryGetIssueParams, SentryGetIssueResponse> = {
id: 'sentry_issues_get',
name: 'Get Issue',
description:
'Retrieve detailed information about a specific Sentry issue by its ID. Returns complete issue details including metadata, tags, and statistics.',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Sentry API authentication token',
},
organizationSlug: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The slug of the organization (e.g., "my-org")',
},
issueId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The unique ID of the issue to retrieve (e.g., "12345")',
},
},
request: {
url: (params) =>
`https://sentry.io/api/0/organizations/${params.organizationSlug}/issues/${params.issueId}/`,
method: 'GET',
headers: (params) => ({
Authorization: `Bearer ${params.apiKey}`,
'Content-Type': 'application/json',
}),
},
transformResponse: async (response: Response) => {
const issue = await response.json()
return {
success: true,
output: {
issue: {
id: issue.id,
shortId: issue.shortId,
title: issue.title,
culprit: issue.culprit ?? null,
permalink: issue.permalink,
logger: issue.logger ?? null,
level: issue.level,
status: issue.status,
statusDetails: issue.statusDetails || {},
isPublic: issue.isPublic,
platform: issue.platform ?? null,
project: {
id: issue.project?.id || '',
name: issue.project?.name || '',
slug: issue.project?.slug || '',
platform: issue.project?.platform || '',
},
type: issue.type ?? null,
metadata: {
type: issue.metadata?.type || null,
value: issue.metadata?.value || null,
function: issue.metadata?.function || null,
},
numComments: issue.numComments || 0,
assignedTo: issue.assignedTo
? {
id: issue.assignedTo.id,
name: issue.assignedTo.name,
email: issue.assignedTo.email,
}
: null,
isBookmarked: issue.isBookmarked,
isSubscribed: issue.isSubscribed,
subscriptionDetails: issue.subscriptionDetails ?? null,
hasSeen: issue.hasSeen,
annotations: issue.annotations || [],
isUnhandled: issue.isUnhandled,
count: issue.count,
userCount: issue.userCount || 0,
firstSeen: issue.firstSeen,
lastSeen: issue.lastSeen,
stats: issue.stats || {},
},
},
}
},
outputs: {
issue: {
type: 'object',
description: 'Detailed information about the Sentry issue',
properties: {
id: { type: 'string', description: 'Unique issue ID' },
shortId: { type: 'string', description: 'Short issue identifier' },
title: { type: 'string', description: 'Issue title' },
culprit: {
type: 'string',
description: 'Function or location that caused the issue',
optional: true,
},
permalink: { type: 'string', description: 'Direct link to the issue in Sentry' },
logger: {
type: 'string',
description: 'Logger name that reported the issue',
optional: true,
},
level: { type: 'string', description: 'Severity level (error, warning, info, etc.)' },
status: { type: 'string', description: 'Current issue status' },
statusDetails: {
type: 'object',
description: 'Additional details about the status',
},
isPublic: { type: 'boolean', description: 'Whether the issue is publicly visible' },
platform: {
type: 'string',
description: 'Platform where the issue occurred',
optional: true,
},
project: {
type: 'object',
description: 'Project information',
properties: {
id: { type: 'string', description: 'Project ID' },
name: { type: 'string', description: 'Project name' },
slug: { type: 'string', description: 'Project slug' },
platform: { type: 'string', description: 'Project platform' },
},
},
type: { type: 'string', description: 'Issue type', optional: true },
metadata: {
type: 'object',
description: 'Error metadata',
properties: {
type: { type: 'string', description: 'Type of error (e.g., TypeError, ValueError)' },
value: { type: 'string', description: 'Error message or value' },
function: { type: 'string', description: 'Function where the error occurred' },
},
},
numComments: { type: 'number', description: 'Number of comments on the issue' },
assignedTo: {
type: 'object',
description: 'User assigned to the issue (if any)',
properties: {
id: { type: 'string', description: 'User ID' },
name: { type: 'string', description: 'User name' },
email: { type: 'string', description: 'User email' },
},
},
isBookmarked: { type: 'boolean', description: 'Whether the issue is bookmarked' },
isSubscribed: { type: 'boolean', description: 'Whether the user is subscribed to updates' },
hasSeen: { type: 'boolean', description: 'Whether the user has seen this issue' },
annotations: { type: 'array', description: 'Issue annotations' },
isUnhandled: { type: 'boolean', description: 'Whether the issue is unhandled' },
count: { type: 'string', description: 'Total number of occurrences' },
userCount: { type: 'number', description: 'Number of unique users affected' },
firstSeen: { type: 'string', description: 'When the issue was first seen (ISO timestamp)' },
lastSeen: { type: 'string', description: 'When the issue was last seen (ISO timestamp)' },
stats: { type: 'object', description: 'Statistical information about the issue' },
},
},
},
}