@cesteral/tiktok-mcp 1.0.0

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

@@ -0,0 +1,297 @@
+import { z } from "zod";
+import type { RequestContext, McpTextContent } from "@cesteral/shared";
+import type { SdkContext } from "@cesteral/shared";
+export declare const DownloadReportInputSchema: z.ZodObject<{
+    downloadUrl: z.ZodString;
+    storeRawCsv: 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"]>>>;
+} & {
+    includeComputedMetrics: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    downloadUrl: string;
+    includeComputedMetrics: boolean;
+    mode: "rows" | "summary";
+    storeRawCsv: boolean;
+    columns?: string[] | undefined;
+    offset?: number | undefined;
+    maxRows?: number | undefined;
+    aggregateBy?: string[] | undefined;
+    aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+}, {
+    downloadUrl: string;
+    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;
+    storeRawCsv?: boolean | undefined;
+}>;
+export declare const DownloadReportOutputSchema: z.ZodObject<{
+    rawCsvResourceUri: z.ZodOptional<z.ZodString>;
+    rawCsvByteLength: z.ZodOptional<z.ZodNumber>;
+    spill: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        bucket: z.ZodString;
+        objectName: z.ZodString;
+        bytes: z.ZodNumber;
+        rowCount: z.ZodOptional<z.ZodNumber>;
+        signedUrl: z.ZodString;
+        expiresAt: z.ZodString;
+        mimeType: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bucket: string;
+        objectName: string;
+        bytes: number;
+        signedUrl: string;
+        expiresAt: string;
+        mimeType: string;
+        rowCount?: number | undefined;
+    }, {
+        bucket: string;
+        objectName: string;
+        bytes: number;
+        signedUrl: string;
+        expiresAt: string;
+        mimeType: string;
+        rowCount?: number | undefined;
+    }>, z.ZodObject<{
+        error: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        error: string;
+    }, {
+        error: string;
+    }>]>>;
+    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">;
+}, "strip", z.ZodTypeAny, {
+    totalRows: number;
+    headers: string[];
+    timestamp: string;
+    mode: "rows" | "summary";
+    returnedRows: number;
+    truncated: boolean;
+    nextOffset: number | null;
+    selectedColumns: string[];
+    warnings: string[];
+    rows?: Record<string, any>[] | undefined;
+    previewRows?: Record<string, any>[] | undefined;
+    rawCsvResourceUri?: string | undefined;
+    rawCsvByteLength?: number | undefined;
+    spill?: {
+        bucket: string;
+        objectName: string;
+        bytes: number;
+        signedUrl: string;
+        expiresAt: string;
+        mimeType: string;
+        rowCount?: number | undefined;
+    } | {
+        error: string;
+    } | undefined;
+}, {
+    totalRows: number;
+    headers: string[];
+    timestamp: string;
+    mode: "rows" | "summary";
+    returnedRows: number;
+    truncated: boolean;
+    nextOffset: number | null;
+    selectedColumns: string[];
+    warnings: string[];
+    rows?: Record<string, any>[] | undefined;
+    previewRows?: Record<string, any>[] | undefined;
+    rawCsvResourceUri?: string | undefined;
+    rawCsvByteLength?: number | undefined;
+    spill?: {
+        bucket: string;
+        objectName: string;
+        bytes: number;
+        signedUrl: string;
+        expiresAt: string;
+        mimeType: string;
+        rowCount?: number | undefined;
+    } | {
+        error: string;
+    } | undefined;
+}>;
+type DownloadInput = z.infer<typeof DownloadReportInputSchema>;
+type DownloadOutput = z.infer<typeof DownloadReportOutputSchema>;
+export declare function downloadReportLogic(input: DownloadInput, _context: RequestContext, sdkContext?: SdkContext): Promise<DownloadOutput>;
+export declare function downloadReportResponseFormatter(result: DownloadOutput): McpTextContent[];
+export declare const downloadReportTool: {
+    name: string;
+    title: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        downloadUrl: z.ZodString;
+        storeRawCsv: 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"]>>>;
+    } & {
+        includeComputedMetrics: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        downloadUrl: string;
+        includeComputedMetrics: boolean;
+        mode: "rows" | "summary";
+        storeRawCsv: boolean;
+        columns?: string[] | undefined;
+        offset?: number | undefined;
+        maxRows?: number | undefined;
+        aggregateBy?: string[] | undefined;
+        aggregateMetrics?: Record<string, "count" | "sum" | "avg" | "min" | "max"> | undefined;
+    }, {
+        downloadUrl: string;
+        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;
+        storeRawCsv?: boolean | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        rawCsvResourceUri: z.ZodOptional<z.ZodString>;
+        rawCsvByteLength: z.ZodOptional<z.ZodNumber>;
+        spill: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            bucket: z.ZodString;
+            objectName: z.ZodString;
+            bytes: z.ZodNumber;
+            rowCount: z.ZodOptional<z.ZodNumber>;
+            signedUrl: z.ZodString;
+            expiresAt: z.ZodString;
+            mimeType: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            bucket: string;
+            objectName: string;
+            bytes: number;
+            signedUrl: string;
+            expiresAt: string;
+            mimeType: string;
+            rowCount?: number | undefined;
+        }, {
+            bucket: string;
+            objectName: string;
+            bytes: number;
+            signedUrl: string;
+            expiresAt: string;
+            mimeType: string;
+            rowCount?: number | undefined;
+        }>, z.ZodObject<{
+            error: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            error: string;
+        }, {
+            error: string;
+        }>]>>;
+        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">;
+    }, "strip", z.ZodTypeAny, {
+        totalRows: number;
+        headers: string[];
+        timestamp: string;
+        mode: "rows" | "summary";
+        returnedRows: number;
+        truncated: boolean;
+        nextOffset: number | null;
+        selectedColumns: string[];
+        warnings: string[];
+        rows?: Record<string, any>[] | undefined;
+        previewRows?: Record<string, any>[] | undefined;
+        rawCsvResourceUri?: string | undefined;
+        rawCsvByteLength?: number | undefined;
+        spill?: {
+            bucket: string;
+            objectName: string;
+            bytes: number;
+            signedUrl: string;
+            expiresAt: string;
+            mimeType: string;
+            rowCount?: number | undefined;
+        } | {
+            error: string;
+        } | undefined;
+    }, {
+        totalRows: number;
+        headers: string[];
+        timestamp: string;
+        mode: "rows" | "summary";
+        returnedRows: number;
+        truncated: boolean;
+        nextOffset: number | null;
+        selectedColumns: string[];
+        warnings: string[];
+        rows?: Record<string, any>[] | undefined;
+        previewRows?: Record<string, any>[] | undefined;
+        rawCsvResourceUri?: string | undefined;
+        rawCsvByteLength?: number | undefined;
+        spill?: {
+            bucket: string;
+            objectName: string;
+            bytes: number;
+            signedUrl: string;
+            expiresAt: string;
+            mimeType: string;
+            rowCount?: number | undefined;
+        } | {
+            error: string;
+        } | undefined;
+    }>;
+    annotations: {
+        readOnlyHint: boolean;
+        openWorldHint: boolean;
+        destructiveHint: boolean;
+        idempotentHint: boolean;
+    };
+    inputExamples: ({
+        label: string;
+        input: {
+            downloadUrl: string;
+            mode?: undefined;
+            columns?: undefined;
+            maxRows?: undefined;
+        };
+    } | {
+        label: string;
+        input: {
+            downloadUrl: string;
+            mode: string;
+            columns: string[];
+            maxRows: number;
+        };
+    })[];
+    logic: typeof downloadReportLogic;
+    responseFormatter: typeof downloadReportResponseFormatter;
+};
+export {};
+//# sourceMappingURL=download-report.tool.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"download-report.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/download-report.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;AAmBnD,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBmB,CAAC;AAE1D,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;gBA/BgD,CAAC;;;;;;;;gBAK/C,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCL,CAAC;AAEtC,KAAK,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC/D,KAAK,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAUjE,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,aAAa,EACpB,QAAQ,EAAE,cAAc,EACxB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,cAAc,CAAC,CAgBzB;AAED,wBAAgB,+BAA+B,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,EAAE,CAOxF;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAjFwD,CAAC;;;;;;;;oBAK/C,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2GzC,CAAC"}

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

@@ -0,0 +1,105 @@
+import { z } from "zod";
+import { resolveSessionServices } from "../utils/resolve-session.js";
+import { reportCsvStore } from "../../../services/session-services.js";
+import { ComputedMetricsFlagSchema, createServiceDownloadedReportView, extractReportIdFromUrl, formatReportViewResponse, ReportViewInputSchema, ReportViewOutputSchema, StoredReportBodyOutputSchema, spillBodyToGcs, } from "@cesteral/shared";
+const TOOL_NAME = "tiktok_download_report";
+const TOOL_TITLE = "Download TikTok Report";
+const TOOL_DESCRIPTION = `Download and parse a TikTok report from a download URL.
+
+After a report task is DONE (via \`tiktok_check_report_status\`), use the \`downloadUrl\` to fetch and parse the CSV data.
+
+**Workflow:**
+1. \`tiktok_submit_report\` → get \`taskId\`
+2. \`tiktok_check_report_status\` → get \`downloadUrl\` when DONE
+3. \`tiktok_download_report\` with that URL → get a bounded summary or paged row slice
+
+**Options:**
+- \`mode: "summary"\` (default) returns headers, counts, and a small preview
+- \`mode: "rows"\` returns one bounded page of rows
+- \`columns\` projects returned rows to selected columns
+- \`offset\` and \`maxRows\` page through rows; \`maxRows\` is capped at 200`;
+export const DownloadReportInputSchema = z
+    .object({
+    downloadUrl: z.string().url().describe("Report download URL from tiktok_check_report_status"),
+    storeRawCsv: z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe("Persist the full CSV body in the in-process report-csv store and return " +
+        "a `report-csv://{id}` resource URI. Use when a downstream tool/user needs " +
+        "the complete CSV but the model only needs a bounded preview. Entries " +
+        "expire after 30 minutes. Sensitive token-like values are redacted before storage."),
+})
+    .merge(ReportViewInputSchema)
+    .merge(ComputedMetricsFlagSchema)
+    .describe("Parameters for downloading a TikTok report");
+export const DownloadReportOutputSchema = z
+    .object({
+    ...ReportViewOutputSchema.shape,
+    timestamp: z.string().datetime(),
+    ...StoredReportBodyOutputSchema.shape,
+})
+    .describe("Downloaded report data");
+const TIKTOK_COMPUTED_METRIC_ALIASES = {
+    cost: ["spend", "cost"],
+    impressions: ["impressions"],
+    clicks: ["clicks"],
+    conversions: ["conversions"],
+    conversionValue: ["conversion_value", "total_purchase_value"],
+};
+export async function downloadReportLogic(input, _context, sdkContext) {
+    const { tiktokReportingService } = resolveSessionServices(sdkContext);
+    return createServiceDownloadedReportView({
+        input,
+        sessionId: sdkContext?.sessionId,
+        reportCsvStore,
+        spillBodyToGcs,
+        spillServer: "tiktok",
+        reportId: extractReportIdFromUrl(input.downloadUrl),
+        computedMetricAliases: TIKTOK_COMPUTED_METRIC_ALIASES,
+        download: ({ fetchLimit, includeRawCsv }) => tiktokReportingService.downloadReport(input.downloadUrl, fetchLimit, undefined, {
+            includeRawCsv,
+        }),
+    });
+}
+export function downloadReportResponseFormatter(result) {
+    return [
+        {
+            type: "text",
+            text: formatReportViewResponse(result, "Report data"),
+        },
+    ];
+}
+export const downloadReportTool = {
+    name: TOOL_NAME,
+    title: TOOL_TITLE,
+    description: TOOL_DESCRIPTION,
+    inputSchema: DownloadReportInputSchema,
+    outputSchema: DownloadReportOutputSchema,
+    annotations: {
+        readOnlyHint: true,
+        openWorldHint: true,
+        destructiveHint: false,
+        idempotentHint: true,
+    },
+    inputExamples: [
+        {
+            label: "Download report summary preview",
+            input: {
+                downloadUrl: "https://analytics.tiktok.com/reports/task-abc123/report.csv",
+            },
+        },
+        {
+            label: "Download selected columns as a paged row slice",
+            input: {
+                downloadUrl: "https://analytics.tiktok.com/reports/task-xyz789/report.csv",
+                mode: "rows",
+                columns: ["campaign_id", "impressions", "spend"],
+                maxRows: 50,
+            },
+        },
+    ],
+    logic: downloadReportLogic,
+    responseFormatter: downloadReportResponseFormatter,
+};
+//# sourceMappingURL=download-report.tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"download-report.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/download-report.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,4BAA4B,EAC5B,cAAc,GACf,MAAM,kBAAkB,CAAC;AAI1B,MAAM,SAAS,GAAG,wBAAwB,CAAC;AAC3C,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;6EAaoD,CAAC;AAE9E,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,qDAAqD,CAAC;IAC7F,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,0EAA0E;QACxE,4EAA4E;QAC5E,uEAAuE;QACvE,mFAAmF,CACtF;CACJ,CAAC;KACD,KAAK,CAAC,qBAAqB,CAAC;KAC5B,KAAK,CAAC,yBAAyB,CAAC;KAChC,QAAQ,CAAC,4CAA4C,CAAC,CAAC;AAE1D,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,GAAG,sBAAsB,CAAC,KAAK;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,GAAG,4BAA4B,CAAC,KAAK;CACtC,CAAC;KACD,QAAQ,CAAC,wBAAwB,CAAC,CAAC;AAKtC,MAAM,8BAA8B,GAAG;IACrC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,CAAC,aAAa,CAAC;IAC5B,MAAM,EAAE,CAAC,QAAQ,CAAC;IAClB,WAAW,EAAE,CAAC,aAAa,CAAC;IAC5B,eAAe,EAAE,CAAC,kBAAkB,EAAE,sBAAsB,CAAC;CAC9D,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,KAAoB,EACpB,QAAwB,EACxB,UAAuB;IAEvB,MAAM,EAAE,sBAAsB,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEtE,OAAO,iCAAiC,CAAC;QACvC,KAAK;QACL,SAAS,EAAE,UAAU,EAAE,SAAS;QAChC,cAAc;QACd,cAAc;QACd,WAAW,EAAE,QAAQ;QACrB,QAAQ,EAAE,sBAAsB,CAAC,KAAK,CAAC,WAAW,CAAC;QACnD,qBAAqB,EAAE,8BAA8B;QACrD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,EAAE,EAAE,CAC1C,sBAAsB,CAAC,cAAc,CAAC,KAAK,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE;YAC9E,aAAa;SACd,CAAC;KACL,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,MAAsB;IACpE,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,wBAAwB,CAAC,MAAM,EAAE,aAAa,CAAC;SACtD;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,yBAAyB;IACtC,YAAY,EAAE,0BAA0B;IACxC,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,IAAI;QACnB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,aAAa,EAAE;QACb;YACE,KAAK,EAAE,iCAAiC;YACxC,KAAK,EAAE;gBACL,WAAW,EAAE,6DAA6D;aAC3E;SACF;QACD;YACE,KAAK,EAAE,gDAAgD;YACvD,KAAK,EAAE;gBACL,WAAW,EAAE,6DAA6D;gBAC1E,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,CAAC,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC;gBAChD,OAAO,EAAE,EAAE;aACZ;SACF;KACF;IACD,KAAK,EAAE,mBAAmB;IAC1B,iBAAiB,EAAE,+BAA+B;CACnD,CAAC"}

package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts

@@ -0,0 +1,105 @@
+import { z } from "zod";
+import type { RequestContext, McpTextContent } from "@cesteral/shared";
+import type { SdkContext } from "@cesteral/shared";
+export declare const DuplicateEntityInputSchema: z.ZodObject<{
+    entityType: z.ZodEnum<[string, ...string[]]>;
+    advertiserId: z.ZodString;
+    entityId: z.ZodString;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    advertiserId: string;
+    entityId: string;
+    options?: Record<string, any> | undefined;
+}, {
+    entityType: string;
+    advertiserId: string;
+    entityId: string;
+    options?: Record<string, any> | undefined;
+}>;
+export declare const DuplicateEntityOutputSchema: z.ZodObject<{
+    newEntity: z.ZodRecord<z.ZodString, z.ZodAny>;
+    sourceEntityId: z.ZodString;
+    entityType: z.ZodString;
+    timestamp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    timestamp: string;
+    newEntity: Record<string, any>;
+    sourceEntityId: string;
+}, {
+    entityType: string;
+    timestamp: string;
+    newEntity: Record<string, any>;
+    sourceEntityId: string;
+}>;
+type DuplicateEntityInput = z.infer<typeof DuplicateEntityInputSchema>;
+type DuplicateEntityOutput = z.infer<typeof DuplicateEntityOutputSchema>;
+export declare function duplicateEntityLogic(input: DuplicateEntityInput, context: RequestContext, sdkContext?: SdkContext): Promise<DuplicateEntityOutput>;
+export declare function duplicateEntityResponseFormatter(result: DuplicateEntityOutput): McpTextContent[];
+export declare const duplicateEntityTool: {
+    name: string;
+    title: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        entityType: z.ZodEnum<[string, ...string[]]>;
+        advertiserId: z.ZodString;
+        entityId: z.ZodString;
+        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        entityType: string;
+        advertiserId: string;
+        entityId: string;
+        options?: Record<string, any> | undefined;
+    }, {
+        entityType: string;
+        advertiserId: string;
+        entityId: string;
+        options?: Record<string, any> | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        newEntity: z.ZodRecord<z.ZodString, z.ZodAny>;
+        sourceEntityId: z.ZodString;
+        entityType: z.ZodString;
+        timestamp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        entityType: string;
+        timestamp: string;
+        newEntity: Record<string, any>;
+        sourceEntityId: string;
+    }, {
+        entityType: string;
+        timestamp: string;
+        newEntity: Record<string, any>;
+        sourceEntityId: string;
+    }>;
+    annotations: {
+        readOnlyHint: boolean;
+        openWorldHint: boolean;
+        idempotentHint: boolean;
+        destructiveHint: boolean;
+    };
+    inputExamples: ({
+        label: string;
+        input: {
+            entityType: string;
+            advertiserId: string;
+            entityId: string;
+            options?: undefined;
+        };
+    } | {
+        label: string;
+        input: {
+            entityType: string;
+            advertiserId: string;
+            entityId: string;
+            options: {
+                adgroup_name: string;
+            };
+        };
+    })[];
+    logic: typeof duplicateEntityLogic;
+    responseFormatter: typeof duplicateEntityResponseFormatter;
+};
+export {};
+//# sourceMappingURL=duplicate-entity.tool.d.ts.map

package/dist/mcp-server/tools/definitions/duplicate-entity.tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"duplicate-entity.tool.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/duplicate-entity.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAWnD,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;EAUsB,CAAC;AAE9D,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;EAOA,CAAC;AAEzC,KAAK,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AACvE,KAAK,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEzE,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,cAAc,EACvB,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,qBAAqB,CAAC,CAgBhC;AAED,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,qBAAqB,GAAG,cAAc,EAAE,CAOhG;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmC/B,CAAC"}

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

@@ -0,0 +1,85 @@
+import { z } from "zod";
+import { resolveSessionServices } from "../utils/resolve-session.js";
+import { getDuplicateEntityTypeEnum } from "../utils/entity-mapping.js";
+const TOOL_NAME = "tiktok_duplicate_entity";
+const TOOL_TITLE = "Duplicate TikTok Ads Entity";
+const TOOL_DESCRIPTION = `Duplicate a TikTok Ads entity (copy it).
+
+**Supported entity types:** ${getDuplicateEntityTypeEnum().join(", ")}
+
+Creates a copy of the entity. The copy is created in DISABLED status by default.
+Use the returned entity ID to make modifications before enabling.`;
+export const DuplicateEntityInputSchema = z
+    .object({
+    entityType: z.enum(getDuplicateEntityTypeEnum()).describe("Type of entity to duplicate"),
+    advertiserId: z.string().min(1).describe("TikTok Advertiser ID"),
+    entityId: z.string().min(1).describe("ID of the entity to duplicate"),
+    options: z
+        .record(z.any())
+        .optional()
+        .describe("Optional copy options (e.g., new name, target campaign ID)"),
+})
+    .describe("Parameters for duplicating a TikTok Ads entity");
+export const DuplicateEntityOutputSchema = z
+    .object({
+    newEntity: z.record(z.any()).describe("Newly created duplicate entity data"),
+    sourceEntityId: z.string(),
+    entityType: z.string(),
+    timestamp: z.string().datetime(),
+})
+    .describe("Entity duplication result");
+export async function duplicateEntityLogic(input, context, sdkContext) {
+    const { tiktokService } = resolveSessionServices(sdkContext);
+    const newEntity = await tiktokService.duplicateEntity(input.entityType, input.entityId, input.options, context);
+    return {
+        newEntity: newEntity,
+        sourceEntityId: input.entityId,
+        entityType: input.entityType,
+        timestamp: new Date().toISOString(),
+    };
+}
+export function duplicateEntityResponseFormatter(result) {
+    return [
+        {
+            type: "text",
+            text: `${result.entityType} ${result.sourceEntityId} duplicated successfully\nNew entity:\n${JSON.stringify(result.newEntity, null, 2)}\n\nTimestamp: ${result.timestamp}`,
+        },
+    ];
+}
+export const duplicateEntityTool = {
+    name: TOOL_NAME,
+    title: TOOL_TITLE,
+    description: TOOL_DESCRIPTION,
+    inputSchema: DuplicateEntityInputSchema,
+    outputSchema: DuplicateEntityOutputSchema,
+    annotations: {
+        readOnlyHint: false,
+        openWorldHint: false,
+        idempotentHint: false,
+        destructiveHint: false,
+    },
+    inputExamples: [
+        {
+            label: "Duplicate a campaign",
+            input: {
+                entityType: "campaign",
+                advertiserId: "1234567890",
+                entityId: "1800123456789",
+            },
+        },
+        {
+            label: "Duplicate an ad group with new name",
+            input: {
+                entityType: "adGroup",
+                advertiserId: "1234567890",
+                entityId: "1700123456789",
+                options: {
+                    adgroup_name: "Copy of Ad Group A",
+                },
+            },
+        },
+    ],
+    logic: duplicateEntityLogic,
+    responseFormatter: duplicateEntityResponseFormatter,
+};
+//# sourceMappingURL=duplicate-entity.tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"duplicate-entity.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/duplicate-entity.tool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,0BAA0B,EAAyB,MAAM,4BAA4B,CAAC;AAI/F,MAAM,SAAS,GAAG,yBAAyB,CAAC;AAC5C,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,gBAAgB,GAAG;;8BAEK,0BAA0B,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;;;kEAGH,CAAC;AAEnE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACxF,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,+BAA+B,CAAC;IACrE,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;SACf,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;CAC1E,CAAC;KACD,QAAQ,CAAC,gDAAgD,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAC5E,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,QAAQ,CAAC,2BAA2B,CAAC,CAAC;AAKzC,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,KAA2B,EAC3B,OAAuB,EACvB,UAAuB;IAEvB,MAAM,EAAE,aAAa,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAE7D,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,eAAe,CACnD,KAAK,CAAC,UAA8B,EACpC,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,OAAO,EACb,OAAO,CACR,CAAC;IAEF,OAAO;QACL,SAAS,EAAE,SAA+C;QAC1D,cAAc,EAAE,KAAK,CAAC,QAAQ;QAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,MAA6B;IAC5E,OAAO;QACL;YACE,IAAI,EAAE,MAAe;YACrB,IAAI,EAAE,GAAG,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,cAAc,0CAA0C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,kBAAkB,MAAM,CAAC,SAAS,EAAE;SAC3K;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,0BAA0B;IACvC,YAAY,EAAE,2BAA2B;IACzC,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK;QACrB,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,qCAAqC;YAC5C,KAAK,EAAE;gBACL,UAAU,EAAE,SAAS;gBACrB,YAAY,EAAE,YAAY;gBAC1B,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE;oBACP,YAAY,EAAE,oBAAoB;iBACnC;aACF;SACF;KACF;IACD,KAAK,EAAE,oBAAoB;IAC3B,iBAAiB,EAAE,gCAAgC;CACpD,CAAC"}