:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
// AUTO-GENERATED from products/subscriptions/mcp/tools.yaml + OpenAPI — do not edit
import { z } from 'zod'
import type { Schemas } from '@/api/generated'
import * as orvalSchemas from '@/generated/subscriptions/api'
import { castStringToInt } from '@/tools/cast-helpers'
import { withPostHogUrl, omitResponseFields, type WithPostHogUrl } from '@/tools/tool-utils'
import type { Context, ToolBase, ZodObjectAny } from '@/tools/types'
const SubscriptionsCreateSchema = () => {
const SubscriptionsCreateBody = orvalSchemas.SubscriptionsCreateBody()
return SubscriptionsCreateBody
}
const subscriptionsCreate = (): ToolBase<ReturnType<typeof SubscriptionsCreateSchema>, Schemas.Subscription> => ({
name: 'subscriptions-create',
schema: SubscriptionsCreateSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsCreateSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const body: Record<string, unknown> = {}
if (params.dashboard !== undefined) {
body['dashboard'] = params.dashboard
}
if (params.insight !== undefined) {
body['insight'] = params.insight
}
if (params.dashboard_export_insights !== undefined) {
body['dashboard_export_insights'] = params.dashboard_export_insights
}
if (params.prompt !== undefined) {
body['prompt'] = params.prompt
}
if (params.ai_prompt_config !== undefined) {
body['ai_prompt_config'] = params.ai_prompt_config
}
if (params.target_type !== undefined) {
body['target_type'] = params.target_type
}
if (params.target_value !== undefined) {
body['target_value'] = params.target_value
}
if (params.frequency !== undefined) {
body['frequency'] = params.frequency
}
if (params.interval !== undefined) {
body['interval'] = params.interval
}
if (params.byweekday !== undefined) {
body['byweekday'] = params.byweekday
}
if (params.bysetpos !== undefined) {
body['bysetpos'] = params.bysetpos
}
if (params.count !== undefined) {
body['count'] = params.count
}
if (params.start_date !== undefined) {
body['start_date'] = params.start_date
}
if (params.until_date !== undefined) {
body['until_date'] = params.until_date
}
if (params.enabled !== undefined) {
body['enabled'] = params.enabled
}
if (params.title !== undefined) {
body['title'] = params.title
}
if (params.integration_id !== undefined) {
body['integration_id'] = params.integration_id
}
if (params.send_test_now !== undefined) {
body['send_test_now'] = params.send_test_now
}
if (params.summary_enabled !== undefined) {
body['summary_enabled'] = params.summary_enabled
}
if (params.summary_prompt_guide !== undefined) {
body['summary_prompt_guide'] = params.summary_prompt_guide
}
if (params.delivery_config !== undefined) {
body['delivery_config'] = params.delivery_config
}
const result = await context.api.request<Schemas.Subscription>({
method: 'POST',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/`,
body,
})
return result
},
})
const SubscriptionsDeleteSchema = () => {
const SubscriptionsDestroyParams = orvalSchemas.SubscriptionsDestroyParams()
return SubscriptionsDestroyParams.omit({ project_id: true }).extend({
id: z.preprocess(castStringToInt, SubscriptionsDestroyParams.shape['id']),
})
}
const subscriptionsDelete = (): ToolBase<ReturnType<typeof SubscriptionsDeleteSchema>, Schemas.Subscription> => ({
name: 'subscriptions-delete',
schema: SubscriptionsDeleteSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsDeleteSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.Subscription>({
method: 'PATCH',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.id))}/`,
body: { deleted: true },
})
const filtered = omitResponseFields(result, ['invite_message']) as typeof result
return filtered
},
})
const SubscriptionsDeliveriesListSchema = () => {
const SubscriptionsDeliveriesListParams = orvalSchemas.SubscriptionsDeliveriesListParams()
const SubscriptionsDeliveriesListQueryParams = orvalSchemas.SubscriptionsDeliveriesListQueryParams()
return SubscriptionsDeliveriesListParams.omit({ project_id: true }).extend(
SubscriptionsDeliveriesListQueryParams.shape
)
}
const subscriptionsDeliveriesList = (): ToolBase<
ReturnType<typeof SubscriptionsDeliveriesListSchema>,
WithPostHogUrl<Schemas.PaginatedSubscriptionDeliveryList>
> => ({
name: 'subscriptions-deliveries-list',
schema: SubscriptionsDeliveriesListSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsDeliveriesListSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.PaginatedSubscriptionDeliveryList>({
method: 'GET',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.subscription_id))}/deliveries/`,
query: {
cursor: params.cursor,
status: params.status,
},
})
const filtered = {
...result,
results: (result.results ?? []).map((item: any) =>
omitResponseFields(item, [
'content_snapshot',
'recipient_results',
'error',
'ai_report',
'ai_report_prompt',
'ai_report_diagnostics',
])
),
} as typeof result
return await withPostHogUrl(context, filtered, '/subscriptions')
},
})
const SubscriptionsDeliveriesRetrieveSchema = () => {
const SubscriptionsDeliveriesRetrieveParams = orvalSchemas.SubscriptionsDeliveriesRetrieveParams()
return SubscriptionsDeliveriesRetrieveParams.omit({ project_id: true })
}
const subscriptionsDeliveriesRetrieve = (): ToolBase<
ReturnType<typeof SubscriptionsDeliveriesRetrieveSchema>,
Schemas.SubscriptionDelivery
> => ({
name: 'subscriptions-deliveries-retrieve',
schema: SubscriptionsDeliveriesRetrieveSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsDeliveriesRetrieveSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.SubscriptionDelivery>({
method: 'GET',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.subscription_id))}/deliveries/${encodeURIComponent(String(params.id))}/`,
})
const filtered = omitResponseFields(result, [
'content_snapshot',
'recipient_results',
'error',
'ai_report_diagnostics',
]) as typeof result
return filtered
},
})
const SubscriptionsListSchema = () => {
const SubscriptionsListQueryParams = orvalSchemas.SubscriptionsListQueryParams()
return SubscriptionsListQueryParams
}
const subscriptionsList = (): ToolBase<
ReturnType<typeof SubscriptionsListSchema>,
WithPostHogUrl<Schemas.PaginatedSubscriptionList>
> => ({
name: 'subscriptions-list',
schema: SubscriptionsListSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsListSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.PaginatedSubscriptionList>({
method: 'GET',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/`,
query: {
created_by: params.created_by,
dashboard: params.dashboard,
dashboard_tiles: params.dashboard_tiles,
insight: params.insight,
insights: params.insights,
limit: params.limit,
offset: params.offset,
ordering: params.ordering,
resource_type: params.resource_type,
search: params.search,
target_type: params.target_type,
},
})
const filtered = {
...result,
results: (result.results ?? []).map((item: any) => omitResponseFields(item, ['invite_message'])),
} as typeof result
return await withPostHogUrl(
context,
{
...filtered,
results: await Promise.all(
(filtered.results ?? []).map((item) => withPostHogUrl(context, item, `/subscriptions/${item.id}`))
),
},
'/subscriptions'
)
},
})
const SubscriptionsPartialUpdateSchema = () => {
const SubscriptionsPartialUpdateBody = orvalSchemas.SubscriptionsPartialUpdateBody()
const SubscriptionsPartialUpdateParams = orvalSchemas.SubscriptionsPartialUpdateParams()
return SubscriptionsPartialUpdateParams.omit({ project_id: true }).extend(SubscriptionsPartialUpdateBody.shape)
}
const subscriptionsPartialUpdate = (): ToolBase<
ReturnType<typeof SubscriptionsPartialUpdateSchema>,
Schemas.Subscription
> => ({
name: 'subscriptions-partial-update',
schema: SubscriptionsPartialUpdateSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsPartialUpdateSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const body: Record<string, unknown> = {}
if (params.dashboard !== undefined) {
body['dashboard'] = params.dashboard
}
if (params.insight !== undefined) {
body['insight'] = params.insight
}
if (params.dashboard_export_insights !== undefined) {
body['dashboard_export_insights'] = params.dashboard_export_insights
}
if (params.prompt !== undefined) {
body['prompt'] = params.prompt
}
if (params.ai_prompt_config !== undefined) {
body['ai_prompt_config'] = params.ai_prompt_config
}
if (params.target_type !== undefined) {
body['target_type'] = params.target_type
}
if (params.target_value !== undefined) {
body['target_value'] = params.target_value
}
if (params.frequency !== undefined) {
body['frequency'] = params.frequency
}
if (params.interval !== undefined) {
body['interval'] = params.interval
}
if (params.byweekday !== undefined) {
body['byweekday'] = params.byweekday
}
if (params.bysetpos !== undefined) {
body['bysetpos'] = params.bysetpos
}
if (params.count !== undefined) {
body['count'] = params.count
}
if (params.start_date !== undefined) {
body['start_date'] = params.start_date
}
if (params.until_date !== undefined) {
body['until_date'] = params.until_date
}
if (params.enabled !== undefined) {
body['enabled'] = params.enabled
}
if (params.title !== undefined) {
body['title'] = params.title
}
if (params.integration_id !== undefined) {
body['integration_id'] = params.integration_id
}
if (params.summary_enabled !== undefined) {
body['summary_enabled'] = params.summary_enabled
}
if (params.summary_prompt_guide !== undefined) {
body['summary_prompt_guide'] = params.summary_prompt_guide
}
if (params.delivery_config !== undefined) {
body['delivery_config'] = params.delivery_config
}
const result = await context.api.request<Schemas.Subscription>({
method: 'PATCH',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.id))}/`,
body,
})
return result
},
})
const SubscriptionsRetrieveSchema = () => {
const SubscriptionsRetrieveParams = orvalSchemas.SubscriptionsRetrieveParams()
return SubscriptionsRetrieveParams.omit({ project_id: true })
}
const subscriptionsRetrieve = (): ToolBase<ReturnType<typeof SubscriptionsRetrieveSchema>, Schemas.Subscription> => ({
name: 'subscriptions-retrieve',
schema: SubscriptionsRetrieveSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsRetrieveSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.Subscription>({
method: 'GET',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.id))}/`,
})
const filtered = omitResponseFields(result, ['invite_message']) as typeof result
return filtered
},
})
const SubscriptionsSummariesListSchema = () => {
const SubscriptionsSummariesListQueryParams = orvalSchemas.SubscriptionsSummariesListQueryParams()
return SubscriptionsSummariesListQueryParams
}
const subscriptionsSummariesList = (): ToolBase<
ReturnType<typeof SubscriptionsSummariesListSchema>,
WithPostHogUrl<Schemas.PaginatedSubscriptionSummaryList>
> => ({
name: 'subscriptions-summaries-list',
schema: SubscriptionsSummariesListSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsSummariesListSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<Schemas.PaginatedSubscriptionSummaryList>({
method: 'GET',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/summaries/`,
query: {
cursor: params.cursor,
dashboard: params.dashboard,
insight: params.insight,
},
})
return await withPostHogUrl(context, result, '/subscriptions')
},
})
const SubscriptionsTestDeliveryCreateSchema = () => {
const SubscriptionsTestDeliveryCreateParams = orvalSchemas.SubscriptionsTestDeliveryCreateParams()
return SubscriptionsTestDeliveryCreateParams.omit({ project_id: true })
}
const subscriptionsTestDeliveryCreate = (): ToolBase<
ReturnType<typeof SubscriptionsTestDeliveryCreateSchema>,
unknown
> => ({
name: 'subscriptions-test-delivery-create',
schema: SubscriptionsTestDeliveryCreateSchema(),
handler: async (context: Context, params: z.infer<ReturnType<typeof SubscriptionsTestDeliveryCreateSchema>>) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.request<unknown>({
method: 'POST',
path: `/api/projects/${encodeURIComponent(String(projectId))}/subscriptions/${encodeURIComponent(String(params.id))}/test-delivery/`,
})
return result
},
})
export const GENERATED_TOOLS: Record<string, () => ToolBase<ZodObjectAny>> = {
'subscriptions-create': subscriptionsCreate,
'subscriptions-delete': subscriptionsDelete,
'subscriptions-deliveries-list': subscriptionsDeliveriesList,
'subscriptions-deliveries-retrieve': subscriptionsDeliveriesRetrieve,
'subscriptions-list': subscriptionsList,
'subscriptions-partial-update': subscriptionsPartialUpdate,
'subscriptions-retrieve': subscriptionsRetrieve,
'subscriptions-summaries-list': subscriptionsSummariesList,
'subscriptions-test-delivery-create': subscriptionsTestDeliveryCreate,
}