Files
simstudioai--sim/apps/sim/tools/mailgun/list_messages.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

82 lines
2.3 KiB
TypeScript

import type { ListMessagesParams, ListMessagesResult } from '@/tools/mailgun/types'
import type { ToolConfig } from '@/tools/types'
export const mailgunListMessagesTool: ToolConfig<ListMessagesParams, ListMessagesResult> = {
id: 'mailgun_list_messages',
name: 'Mailgun List Messages',
description: 'List events (logs) for messages sent through Mailgun',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Mailgun API key',
},
domain: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Mailgun domain for listing events (e.g., mg.example.com)',
},
event: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Filter by event type (accepted, delivered, failed, opened, clicked, etc.)',
},
limit: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Maximum number of events to return (default: 100)',
},
},
request: {
url: (params) => {
const baseUrl = `https://api.mailgun.net/v3/${params.domain}/events`
const queryParams = new URLSearchParams()
if (params.event) {
queryParams.append('event', params.event)
}
if (params.limit) {
queryParams.append('limit', params.limit.toString())
}
const query = queryParams.toString()
return query ? `${baseUrl}?${query}` : baseUrl
},
method: 'GET',
headers: (params) => ({
Authorization: `Basic ${Buffer.from(`api:${params.apiKey}`).toString('base64')}`,
}),
},
transformResponse: async (response, params): Promise<ListMessagesResult> => {
if (!response.ok) {
const error = await response.json()
throw new Error(error.message || 'Failed to list messages')
}
const result = await response.json()
return {
success: true,
output: {
success: true,
items: result.items || [],
paging: result.paging || {},
},
}
},
outputs: {
success: { type: 'boolean', description: 'Whether the request was successful' },
items: { type: 'json', description: 'Array of event items' },
paging: { type: 'json', description: 'Paging information' },
},
}