@cesteral/tiktok-mcp 1.0.0

package/dist/mcp-server/tools/definitions/get-entity.tool.js

@@ -0,0 +1,71 @@
+import { z } from "zod";
+import { resolveSessionServices } from "../utils/resolve-session.js";
+import { getEntityTypeEnum } from "../utils/entity-mapping.js";
+const TOOL_NAME = "tiktok_get_entity";
+const TOOL_TITLE = "Get TikTok Ads Entity";
+const TOOL_DESCRIPTION = `Get a single TikTok Ads entity by ID.
+
+**Supported entity types:** ${getEntityTypeEnum().join(", ")}`;
+export const GetEntityInputSchema = z
+    .object({
+    entityType: z.enum(getEntityTypeEnum()).describe("Type of entity to retrieve"),
+    advertiserId: z.string().min(1).describe("TikTok Advertiser ID"),
+    entityId: z.string().min(1).describe("The entity ID to retrieve"),
+})
+    .describe("Parameters for getting a TikTok Ads entity");
+export const GetEntityOutputSchema = z
+    .object({
+    entity: z.record(z.any()).describe("Retrieved entity data"),
+    timestamp: z.string().datetime(),
+})
+    .describe("Entity retrieval result");
+export async function getEntityLogic(input, context, sdkContext) {
+    const { tiktokService } = resolveSessionServices(sdkContext);
+    const entity = await tiktokService.getEntity(input.entityType, input.entityId, context);
+    return {
+        entity: entity,
+        timestamp: new Date().toISOString(),
+    };
+}
+export function getEntityResponseFormatter(result) {
+    return [
+        {
+            type: "text",
+            text: `Entity retrieved\n${JSON.stringify(result.entity, null, 2)}\n\nTimestamp: ${result.timestamp}`,
+        },
+    ];
+}
+export const getEntityTool = {
+    name: TOOL_NAME,
+    title: TOOL_TITLE,
+    description: TOOL_DESCRIPTION,
+    inputSchema: GetEntityInputSchema,
+    outputSchema: GetEntityOutputSchema,
+    annotations: {
+        readOnlyHint: true,
+        openWorldHint: false,
+        idempotentHint: true,
+        destructiveHint: false,
+    },
+    inputExamples: [
+        {
+            label: "Get a campaign by ID",
+            input: {
+                entityType: "campaign",
+                advertiserId: "1234567890",
+                entityId: "1800123456789",
+            },
+        },
+        {
+            label: "Get an ad group by ID",
+            input: {
+                entityType: "adGroup",
+                advertiserId: "1234567890",
+                entityId: "1700123456789",
+            },
+        },
+    ],
+    logic: getEntityLogic,
+    responseFormatter: getEntityResponseFormatter,
+};
+//# sourceMappingURL=get-entity.tool.js.map

package/dist/mcp-server/tools/definitions/get-entity.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-entity.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-entity.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAyB,MAAM,4BAA4B,CAAC;AAItF,MAAM,SAAS,GAAG,mBAAmB,CAAC;AACtC,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAC3C,MAAM,gBAAgB,GAAG;;8BAEK,iBAAiB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAE/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC9E,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAChE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CAClE,CAAC;KACD,QAAQ,CAAC,4CAA4C,CAAC,CAAC;AAE1D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC3D,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,yBAAyB,CAAC,CAAC;AAKvC,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAqB,EACrB,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,aAAa,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAC1C,KAAK,CAAC,UAA8B,EACpC,KAAK,CAAC,QAAQ,EACd,OAAO,CACR,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,MAA4C;QACpD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAuB;IAChE,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,qBAAqB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,MAAM,CAAC,SAAS,EAAE;SACtG;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,oBAAoB;IACjC,YAAY,EAAE,qBAAqB;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,sBAAsB;YAC7B,KAAK,EAAE;gBACL,UAAU,EAAE,UAAU;gBACtB,YAAY,EAAE,YAAY;gBAC1B,QAAQ,EAAE,eAAe;aAC1B;SACF;QACD;YACE,KAAK,EAAE,uBAAuB;YAC9B,KAAK,EAAE;gBACL,UAAU,EAAE,SAAS;gBACrB,YAAY,EAAE,YAAY;gBAC1B,QAAQ,EAAE,eAAe;aAC1B;SACF;KACF;IACD,KAAK,EAAE,cAAc;IACrB,iBAAiB,EAAE,0BAA0B;CAC9C,CAAC"}

package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts

@@ -0,0 +1,295 @@
+import { z } from "zod";
+import type { RequestContext, McpTextContent } from "@cesteral/shared";
+import type { SdkContext } from "@cesteral/shared";
+export declare const GetReportBreakdownsInputSchema: z.ZodEffects<z.ZodObject<{
+    advertiserId: z.ZodString;
+    reportType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["BASIC", "AUDIENCE", "PLAYABLE_MATERIAL"]>>>;
+    dimensions: z.ZodArray<z.ZodString, "many">;
+    breakdowns: z.ZodArray<z.ZodString, "many">;
+    metrics: z.ZodArray<z.ZodString, "many">;
+    datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
+    startDate: z.ZodOptional<z.ZodString>;
+    endDate: z.ZodOptional<z.ZodString>;
+    includeComputedMetrics: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+} & {
+    mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
+    columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    maxRows: z.ZodOptional<z.ZodNumber>;
+    aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
+}, "strip", z.ZodTypeAny, {
+    dimensions: string[];
+    metrics: string[];
+    advertiserId: string;
+    reportType: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL";
+    includeComputedMetrics: boolean;
+    mode: "rows" | "summary";
+    breakdowns: string[];
+    datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
+    columns?: string[] | undefined;
+    offset?: number | undefined;
+    maxRows?: number | undefined;
+    aggregateBy?: string[] | undefined;
+    aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+}, {
+    dimensions: string[];
+    metrics: string[];
+    advertiserId: string;
+    breakdowns: string[];
+    reportType?: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL" | undefined;
+    datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
+    includeComputedMetrics?: boolean | undefined;
+    mode?: "rows" | "summary" | undefined;
+    columns?: string[] | undefined;
+    offset?: number | undefined;
+    maxRows?: number | undefined;
+    aggregateBy?: string[] | undefined;
+    aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+}>, {
+    dimensions: string[];
+    metrics: string[];
+    advertiserId: string;
+    reportType: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL";
+    includeComputedMetrics: boolean;
+    mode: "rows" | "summary";
+    breakdowns: string[];
+    datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
+    columns?: string[] | undefined;
+    offset?: number | undefined;
+    maxRows?: number | undefined;
+    aggregateBy?: string[] | undefined;
+    aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+}, {
+    dimensions: string[];
+    metrics: string[];
+    advertiserId: string;
+    breakdowns: string[];
+    reportType?: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL" | undefined;
+    datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
+    includeComputedMetrics?: boolean | undefined;
+    mode?: "rows" | "summary" | undefined;
+    columns?: string[] | undefined;
+    offset?: number | undefined;
+    maxRows?: number | undefined;
+    aggregateBy?: string[] | undefined;
+    aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+}>;
+export declare const GetReportBreakdownsOutputSchema: z.ZodObject<{
+    appliedDimensions: z.ZodArray<z.ZodString, "many">;
+    timestamp: z.ZodString;
+    totalRows: z.ZodNumber;
+    returnedRows: z.ZodNumber;
+    truncated: z.ZodBoolean;
+    nextOffset: z.ZodNullable<z.ZodNumber>;
+    headers: z.ZodArray<z.ZodString, "many">;
+    selectedColumns: z.ZodArray<z.ZodString, "many">;
+    mode: z.ZodEnum<["summary", "rows"]>;
+    previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
+    rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
+    warnings: z.ZodArray<z.ZodString, "many">;
+    taskId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    taskId: string;
+    totalRows: number;
+    headers: string[];
+    timestamp: string;
+    mode: "rows" | "summary";
+    returnedRows: number;
+    truncated: boolean;
+    nextOffset: number | null;
+    selectedColumns: string[];
+    warnings: string[];
+    appliedDimensions: string[];
+    rows?: Record<string, any>[] | undefined;
+    previewRows?: Record<string, any>[] | undefined;
+}, {
+    taskId: string;
+    totalRows: number;
+    headers: string[];
+    timestamp: string;
+    mode: "rows" | "summary";
+    returnedRows: number;
+    truncated: boolean;
+    nextOffset: number | null;
+    selectedColumns: string[];
+    warnings: string[];
+    appliedDimensions: string[];
+    rows?: Record<string, any>[] | undefined;
+    previewRows?: Record<string, any>[] | undefined;
+}>;
+type GetReportBreakdownsInput = z.infer<typeof GetReportBreakdownsInputSchema>;
+type GetReportBreakdownsOutput = z.infer<typeof GetReportBreakdownsOutputSchema>;
+export declare function getReportBreakdownsLogic(input: GetReportBreakdownsInput, context: RequestContext, sdkContext?: SdkContext): Promise<GetReportBreakdownsOutput>;
+export declare function getReportBreakdownsResponseFormatter(result: GetReportBreakdownsOutput): McpTextContent[];
+export declare const getReportBreakdownsTool: {
+    name: string;
+    title: string;
+    description: string;
+    inputSchema: z.ZodEffects<z.ZodObject<{
+        advertiserId: z.ZodString;
+        reportType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["BASIC", "AUDIENCE", "PLAYABLE_MATERIAL"]>>>;
+        dimensions: z.ZodArray<z.ZodString, "many">;
+        breakdowns: z.ZodArray<z.ZodString, "many">;
+        metrics: z.ZodArray<z.ZodString, "many">;
+        datePreset: z.ZodOptional<z.ZodEnum<["TODAY", "YESTERDAY", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "THIS_MONTH", "LAST_MONTH", "LAST_90_DAYS"]>>;
+        startDate: z.ZodOptional<z.ZodString>;
+        endDate: z.ZodOptional<z.ZodString>;
+        includeComputedMetrics: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    } & {
+        mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["summary", "rows"]>>>;
+        columns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        maxRows: z.ZodOptional<z.ZodNumber>;
+        aggregateBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        aggregateMetrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<["sum", "avg", "count", "min", "max"]>>>;
+    }, "strip", z.ZodTypeAny, {
+        dimensions: string[];
+        metrics: string[];
+        advertiserId: string;
+        reportType: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL";
+        includeComputedMetrics: boolean;
+        mode: "rows" | "summary";
+        breakdowns: string[];
+        datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        columns?: string[] | undefined;
+        offset?: number | undefined;
+        maxRows?: number | undefined;
+        aggregateBy?: string[] | undefined;
+        aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+    }, {
+        dimensions: string[];
+        metrics: string[];
+        advertiserId: string;
+        breakdowns: string[];
+        reportType?: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL" | undefined;
+        datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        includeComputedMetrics?: boolean | undefined;
+        mode?: "rows" | "summary" | undefined;
+        columns?: string[] | undefined;
+        offset?: number | undefined;
+        maxRows?: number | undefined;
+        aggregateBy?: string[] | undefined;
+        aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+    }>, {
+        dimensions: string[];
+        metrics: string[];
+        advertiserId: string;
+        reportType: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL";
+        includeComputedMetrics: boolean;
+        mode: "rows" | "summary";
+        breakdowns: string[];
+        datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        columns?: string[] | undefined;
+        offset?: number | undefined;
+        maxRows?: number | undefined;
+        aggregateBy?: string[] | undefined;
+        aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+    }, {
+        dimensions: string[];
+        metrics: string[];
+        advertiserId: string;
+        breakdowns: string[];
+        reportType?: "BASIC" | "AUDIENCE" | "PLAYABLE_MATERIAL" | undefined;
+        datePreset?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_14_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "LAST_90_DAYS" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        includeComputedMetrics?: boolean | undefined;
+        mode?: "rows" | "summary" | undefined;
+        columns?: string[] | undefined;
+        offset?: number | undefined;
+        maxRows?: number | undefined;
+        aggregateBy?: string[] | undefined;
+        aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        appliedDimensions: z.ZodArray<z.ZodString, "many">;
+        timestamp: z.ZodString;
+        totalRows: z.ZodNumber;
+        returnedRows: z.ZodNumber;
+        truncated: z.ZodBoolean;
+        nextOffset: z.ZodNullable<z.ZodNumber>;
+        headers: z.ZodArray<z.ZodString, "many">;
+        selectedColumns: z.ZodArray<z.ZodString, "many">;
+        mode: z.ZodEnum<["summary", "rows"]>;
+        previewRows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
+        rows: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">>;
+        warnings: z.ZodArray<z.ZodString, "many">;
+        taskId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        taskId: string;
+        totalRows: number;
+        headers: string[];
+        timestamp: string;
+        mode: "rows" | "summary";
+        returnedRows: number;
+        truncated: boolean;
+        nextOffset: number | null;
+        selectedColumns: string[];
+        warnings: string[];
+        appliedDimensions: string[];
+        rows?: Record<string, any>[] | undefined;
+        previewRows?: Record<string, any>[] | undefined;
+    }, {
+        taskId: string;
+        totalRows: number;
+        headers: string[];
+        timestamp: string;
+        mode: "rows" | "summary";
+        returnedRows: number;
+        truncated: boolean;
+        nextOffset: number | null;
+        selectedColumns: string[];
+        warnings: string[];
+        appliedDimensions: string[];
+        rows?: Record<string, any>[] | undefined;
+        previewRows?: Record<string, any>[] | undefined;
+    }>;
+    annotations: {
+        readOnlyHint: boolean;
+        openWorldHint: boolean;
+        idempotentHint: boolean;
+        destructiveHint: boolean;
+    };
+    inputExamples: ({
+        label: string;
+        input: {
+            advertiserId: string;
+            dimensions: string[];
+            breakdowns: string[];
+            metrics: string[];
+            datePreset: string;
+            startDate?: undefined;
+            endDate?: undefined;
+        };
+    } | {
+        label: string;
+        input: {
+            advertiserId: string;
+            dimensions: string[];
+            breakdowns: string[];
+            metrics: string[];
+            startDate: string;
+            endDate: string;
+            datePreset?: undefined;
+        };
+    })[];
+    logic: typeof getReportBreakdownsLogic;
+    responseFormatter: typeof getReportBreakdownsResponseFormatter;
+};
+export {};
+//# sourceMappingURL=get-report-breakdowns.tool.d.ts.map

package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-report-breakdowns.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAYnD,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8CiC,CAAC;AAE7E,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOA,CAAC;AAE7C,KAAK,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC/E,KAAK,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAsCjF,wBAAsB,wBAAwB,CAC5C,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,yBAAyB,CAAC,CA0CpC;AAED,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,yBAAyB,GAChC,cAAc,EAAE,CAOlB;AAED,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCnC,CAAC"}

package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js

@@ -0,0 +1,174 @@
+import { z } from "zod";
+import { resolveSessionServices } from "../utils/resolve-session.js";
+import { arrayRowsToRecords, computeMetrics, createReportView, formatReportViewResponse, getReportViewFetchLimit, resolveDatePreset, DATE_PRESET_VALUES, ReportViewInputSchema, ReportViewOutputSchema, } from "@cesteral/shared";
+const TOOL_NAME = "tiktok_get_report_breakdowns";
+const TOOL_TITLE = "Get TikTok Ads Report with Breakdowns";
+const TOOL_DESCRIPTION = `Submit and retrieve an async TikTok Ads report with dimensional breakdowns.
+
+Like \`tiktok_get_report\` but adds breakdown dimensions for more granular data.
+
+**Common breakdown dimensions:** country_code, platform, gender, age, interest_category, placement
+
+Results are broken down by each combination of base dimensions + breakdown dimensions.`;
+export const GetReportBreakdownsInputSchema = z
+    .object({
+    advertiserId: z.string().min(1).describe("TikTok Advertiser ID"),
+    reportType: z
+        .enum(["BASIC", "AUDIENCE", "PLAYABLE_MATERIAL"])
+        .optional()
+        .default("BASIC")
+        .describe("Report type (default: BASIC)"),
+    dimensions: z
+        .array(z.string())
+        .min(1)
+        .describe("Base dimensions for the report (e.g., ['campaign_id', 'stat_time_day'])"),
+    breakdowns: z
+        .array(z.string())
+        .min(1)
+        .describe("Breakdown dimensions to add (e.g., ['country_code', 'gender'])"),
+    metrics: z
+        .array(z.string())
+        .min(1)
+        .describe("Metrics to include (e.g., ['impressions', 'clicks', 'spend'])"),
+    datePreset: z
+        .enum(DATE_PRESET_VALUES)
+        .optional()
+        .describe("Preset date range. Use this OR startDate+endDate (not both)"),
+    startDate: z
+        .string()
+        .regex(/^\d{4}-\d{2}-\d{2}$/)
+        .optional()
+        .describe("Start date (YYYY-MM-DD, required if datePreset not provided)"),
+    endDate: z
+        .string()
+        .regex(/^\d{4}-\d{2}-\d{2}$/)
+        .optional()
+        .describe("End date (YYYY-MM-DD, required if datePreset not provided)"),
+    includeComputedMetrics: z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe("Include computed CPA, ROAS, CPM, CTR, CPC derived from raw metrics"),
+})
+    .merge(ReportViewInputSchema)
+    .refine((data) => data.datePreset !== undefined || (data.startDate !== undefined && data.endDate !== undefined), { message: "Provide either datePreset or both startDate and endDate" })
+    .describe("Parameters for generating a TikTok Ads report with breakdowns");
+export const GetReportBreakdownsOutputSchema = z
+    .object({
+    taskId: z.string().describe("Report task ID"),
+    ...ReportViewOutputSchema.shape,
+    appliedDimensions: z.array(z.string()).describe("All dimensions used (base + breakdowns)"),
+    timestamp: z.string().datetime(),
+})
+    .describe("Report with breakdowns result");
+function appendComputedMetricsToRows(headers, rows) {
+    const idx = (name) => headers.findIndex((h) => h.toLowerCase() === name.toLowerCase());
+    const spendIdx = idx("spend");
+    const impIdx = idx("impressions");
+    const clickIdx = idx("clicks");
+    const convIdx = idx("conversions");
+    const newHeaders = [
+        ...headers,
+        "computed_cpa",
+        "computed_roas",
+        "computed_cpm",
+        "computed_ctr",
+        "computed_cpc",
+    ];
+    const newRows = rows.map((row) => {
+        const cost = spendIdx >= 0 ? Number(row[spendIdx] || 0) : 0;
+        const impressions = impIdx >= 0 ? Number(row[impIdx] || 0) : 0;
+        const clicks = clickIdx >= 0 ? Number(row[clickIdx] || 0) : 0;
+        const conversions = convIdx >= 0 ? Number(row[convIdx] || 0) : 0;
+        const m = computeMetrics({ cost, impressions, clicks, conversions, conversionValue: 0 });
+        return [
+            ...row,
+            m.cpa !== null ? String(m.cpa) : "",
+            m.roas !== null ? String(m.roas) : "",
+            m.cpm !== null ? String(m.cpm) : "",
+            m.ctr !== null ? String(m.ctr) : "",
+            m.cpc !== null ? String(m.cpc) : "",
+        ];
+    });
+    return { headers: newHeaders, rows: newRows };
+}
+export async function getReportBreakdownsLogic(input, context, sdkContext) {
+    const { tiktokReportingService } = resolveSessionServices(sdkContext);
+    let resolvedStartDate = input.startDate;
+    let resolvedEndDate = input.endDate;
+    if (input.datePreset) {
+        const resolved = resolveDatePreset(input.datePreset);
+        resolvedStartDate = resolved.startDate;
+        resolvedEndDate = resolved.endDate;
+    }
+    const result = await tiktokReportingService.getReportBreakdowns({
+        report_type: input.reportType,
+        dimensions: input.dimensions,
+        metrics: input.metrics,
+        start_date: resolvedStartDate,
+        end_date: resolvedEndDate,
+    }, input.breakdowns, getReportViewFetchLimit(input), context);
+    let headers = result.headers;
+    let rows = result.rows;
+    if (input.includeComputedMetrics) {
+        ({ headers, rows } = appendComputedMetricsToRows(headers, rows));
+    }
+    return {
+        taskId: result.taskId,
+        ...createReportView({
+            headers,
+            rows: arrayRowsToRecords(headers, rows),
+            totalRows: result.totalRows,
+            input,
+        }),
+        appliedDimensions: [...input.dimensions, ...input.breakdowns],
+        timestamp: new Date().toISOString(),
+    };
+}
+export function getReportBreakdownsResponseFormatter(result) {
+    return [
+        {
+            type: "text",
+            text: `Report task: ${result.taskId}\nApplied dimensions: ${result.appliedDimensions.join(", ")}\n\n${formatReportViewResponse(result, "Report data")}`,
+        },
+    ];
+}
+export const getReportBreakdownsTool = {
+    name: TOOL_NAME,
+    title: TOOL_TITLE,
+    description: TOOL_DESCRIPTION,
+    inputSchema: GetReportBreakdownsInputSchema,
+    outputSchema: GetReportBreakdownsOutputSchema,
+    annotations: {
+        readOnlyHint: true,
+        openWorldHint: false,
+        idempotentHint: false,
+        destructiveHint: false,
+    },
+    inputExamples: [
+        {
+            label: "Campaign report broken down by country",
+            input: {
+                advertiserId: "1234567890",
+                dimensions: ["campaign_id", "stat_time_day"],
+                breakdowns: ["country_code"],
+                metrics: ["impressions", "clicks", "spend", "ctr"],
+                datePreset: "LAST_7_DAYS",
+            },
+        },
+        {
+            label: "Ad group report broken down by gender and age",
+            input: {
+                advertiserId: "1234567890",
+                dimensions: ["adgroup_id"],
+                breakdowns: ["gender", "age"],
+                metrics: ["impressions", "clicks", "spend", "conversions"],
+                startDate: "2026-03-01",
+                endDate: "2026-03-04",
+            },
+        },
+    ],
+    logic: getReportBreakdownsLogic,
+    responseFormatter: getReportBreakdownsResponseFormatter,
+};
+//# sourceMappingURL=get-report-breakdowns.tool.js.map

package/dist/mcp-server/tools/definitions/get-report-breakdowns.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-report-breakdowns.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/get-report-breakdowns.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,kBAAkB,CAAC;AAI1B,MAAM,SAAS,GAAG,8BAA8B,CAAC;AACjD,MAAM,UAAU,GAAG,uCAAuC,CAAC;AAC3D,MAAM,gBAAgB,GAAG;;;;;;uFAM8D,CAAC;AAExF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAChE,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;SAChD,QAAQ,EAAE;SACV,OAAO,CAAC,OAAO,CAAC;SAChB,QAAQ,CAAC,8BAA8B,CAAC;IAC3C,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,yEAAyE,CAAC;IACtF,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,+DAA+D,CAAC;IAC5E,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,kBAAkB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,KAAK,CAAC,qBAAqB,CAAC;SAC5B,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,KAAK,CAAC,qBAAqB,CAAC;SAC5B,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;IACzE,sBAAsB,EAAE,CAAC;SACtB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,oEAAoE,CAAC;CAClF,CAAC;KACD,KAAK,CAAC,qBAAqB,CAAC;KAC5B,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,EAC/F,EAAE,OAAO,EAAE,yDAAyD,EAAE,CACvE;KACA,QAAQ,CAAC,+DAA+D,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC7C,GAAG,sBAAsB,CAAC,KAAK;IAC/B,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IAC1F,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,+BAA+B,CAAC,CAAC;AAK7C,SAAS,2BAA2B,CAClC,OAAiB,EACjB,IAAgB;IAEhB,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/F,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IAEnC,MAAM,UAAU,GAAG;QACjB,GAAG,OAAO;QACV,cAAc;QACd,eAAe;QACf,cAAc;QACd,cAAc;QACd,cAAc;KACf,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,MAAM,IAAI,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC;QACzF,OAAO;YACL,GAAG,GAAG;YACN,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;YACrC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YACnC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;SACpC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAChD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAA+B,EAC/B,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,sBAAsB,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEtE,IAAI,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC;IACxC,IAAI,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC;IACpC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,iBAAiB,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC;IACrC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC,mBAAmB,CAC7D;QACE,WAAW,EAAE,KAAK,CAAC,UAAU;QAC7B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,UAAU,EAAE,iBAAkB;QAC9B,QAAQ,EAAE,eAAgB;KAC3B,EACD,KAAK,CAAC,UAAU,EAChB,uBAAuB,CAAC,KAAK,CAAC,EAC9B,OAAO,CACR,CAAC;IAEF,IAAI,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC7B,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAEvB,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;QACjC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,2BAA2B,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,gBAAgB,CAAC;YAClB,OAAO;YACP,IAAI,EAAE,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC;YACvC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK;SACN,CAAC;QACF,iBAAiB,EAAE,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC;QAC7D,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oCAAoC,CAClD,MAAiC;IAEjC,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,gBAAgB,MAAM,CAAC,MAAM,yBAAyB,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,wBAAwB,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE;SACxJ;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,8BAA8B;IAC3C,YAAY,EAAE,+BAA+B;IAC7C,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK;QACrB,eAAe,EAAE,KAAK;KACvB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,wCAAwC;YAC/C,KAAK,EAAE;gBACL,YAAY,EAAE,YAAY;gBAC1B,UAAU,EAAE,CAAC,aAAa,EAAE,eAAe,CAAC;gBAC5C,UAAU,EAAE,CAAC,cAAc,CAAC;gBAC5B,OAAO,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC;gBAClD,UAAU,EAAE,aAAa;aAC1B;SACF;QACD;YACE,KAAK,EAAE,+CAA+C;YACtD,KAAK,EAAE;gBACL,YAAY,EAAE,YAAY;gBAC1B,UAAU,EAAE,CAAC,YAAY,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC;gBAC7B,OAAO,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,CAAC;gBAC1D,SAAS,EAAE,YAAY;gBACvB,OAAO,EAAE,YAAY;aACtB;SACF;KACF;IACD,KAAK,EAAE,wBAAwB;IAC/B,iBAAiB,EAAE,oCAAoC;CACxD,CAAC"}