mcp-meta-ads-incrementality 0.2.2 → 0.3.0

package/dist/toolDefinitions.d.ts

@@ -0,0 +1,772 @@
+/**
+ * Tool definitions (JSONSchema) for mcp-meta-ads-incrementality.
+ *
+ * Pure data — no side effects — so tests (writeGate.test.ts) can import the
+ * full tool list without triggering the server entrypoint in index.ts
+ * (credential resolution, SDK init, stdio transport).
+ */
+export declare const TOOLS: ({
+    readonly name: "meta_ads_insights_incrementality";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_account_id: {
+                readonly type: "string";
+                readonly description: "Meta ad account id (with or without the act_ prefix).";
+            };
+            readonly date_range: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly since: {
+                        readonly type: "string";
+                        readonly description: "YYYY-MM-DD start date (inclusive)";
+                    };
+                    readonly until: {
+                        readonly type: "string";
+                        readonly description: "YYYY-MM-DD end date (inclusive)";
+                    };
+                };
+                readonly required: readonly ["since", "until"];
+            };
+            readonly conversion_event_name: {
+                readonly type: "string";
+                readonly description: string;
+            };
+            readonly attribution_windows: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly enum: readonly ["incrementality", "1d_click", "7d_click", "28d_click", "1d_view", "1d_ev", "dda", "skan_view", "skan_click"];
+                };
+                readonly description: string;
+            };
+            readonly level: {
+                readonly type: "string";
+                readonly enum: readonly ["account", "campaign", "adset", "ad"];
+                readonly description: "Aggregation level. Defaults to \"campaign\".";
+            };
+            readonly campaign_id: {
+                readonly type: "string";
+                readonly description: "Optional: restrict to a single campaign.";
+            };
+            readonly adset_id: {
+                readonly type: "string";
+                readonly description: "Optional: restrict to a single ad set.";
+            };
+            readonly breakdowns: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Optional Meta breakdowns, e.g. [\"publisher_platform\", \"age\"].";
+            };
+        };
+        readonly required: readonly ["ad_account_id", "date_range", "conversion_event_name"];
+    };
+} | {
+    readonly name: "meta_ads_list_ads_in_campaign";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly campaign_id: {
+                readonly type: "string";
+                readonly description: "Meta campaign id (numeric).";
+            };
+        };
+        readonly required: readonly ["campaign_id"];
+    };
+} | {
+    readonly name: "meta_ads_get_ad_url_tags";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+        };
+        readonly required: readonly ["ad_id"];
+    };
+} | {
+    readonly name: "meta_ads_update_ad_url_tags";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+            readonly url_tags: {
+                readonly type: "string";
+                readonly description: string;
+            };
+            readonly dry_run: {
+                readonly type: "boolean";
+                readonly description: "If true, return a diff without writing. Default false.";
+            };
+        };
+        readonly required: readonly ["ad_id", "url_tags"];
+    };
+} | {
+    readonly name: "meta_ads_rename_ad";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+            readonly new_name: {
+                readonly type: "string";
+                readonly description: "New ad name.";
+            };
+            readonly dry_run: {
+                readonly type: "boolean";
+                readonly description: "If true, return a diff without writing. Default false.";
+            };
+            readonly allow_naming_violations: {
+                readonly type: "boolean";
+                readonly description: "If true, bypass the naming-standards check. Default false.";
+            };
+        };
+        readonly required: readonly ["ad_id", "new_name"];
+    };
+} | {
+    readonly name: "meta_ads_create_campaign";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+                readonly description: "Ad account id (with or without act_ prefix).";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly objective: {
+                readonly type: "string";
+                readonly description: "Meta objective enum, e.g. OUTCOME_LEADS, OUTCOME_TRAFFIC, OUTCOME_SALES.";
+            };
+            readonly status: {
+                readonly type: "string";
+                readonly enum: readonly ["PAUSED", "ACTIVE"];
+                readonly description: "Default PAUSED.";
+            };
+            readonly special_ad_categories: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "e.g. [\"HOUSING\"]. Default [].";
+            };
+            readonly buying_type: {
+                readonly type: "string";
+                readonly enum: readonly ["AUCTION", "RESERVED"];
+                readonly description: "Default AUCTION.";
+            };
+            readonly daily_budget: {
+                readonly type: "number";
+                readonly description: "Cents. Set only for CBO campaigns.";
+            };
+            readonly lifetime_budget: {
+                readonly type: "number";
+                readonly description: "Cents. Alternative to daily_budget.";
+            };
+        };
+        readonly required: readonly ["account_id", "name", "objective"];
+    };
+} | {
+    readonly name: "meta_ads_create_adset";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly campaign_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly optimization_goal: {
+                readonly type: "string";
+                readonly description: "e.g. LEAD_GENERATION, OFFSITE_CONVERSIONS, LINK_CLICKS, REACH.";
+            };
+            readonly billing_event: {
+                readonly type: "string";
+                readonly enum: readonly ["IMPRESSIONS", "LINK_CLICKS", "POST_ENGAGEMENT", "THRUPLAY"];
+            };
+            readonly bid_strategy: {
+                readonly type: "string";
+                readonly enum: readonly ["LOWEST_COST_WITHOUT_CAP", "LOWEST_COST_WITH_BID_CAP", "COST_CAP"];
+                readonly description: "Default LOWEST_COST_WITHOUT_CAP (Highest volume).";
+            };
+            readonly bid_amount: {
+                readonly type: "number";
+                readonly description: "Cents. Required for COST_CAP / WITH_BID_CAP.";
+            };
+            readonly targeting: {
+                readonly type: "object";
+                readonly description: "Full Meta targeting spec.";
+            };
+            readonly status: {
+                readonly type: "string";
+                readonly enum: readonly ["PAUSED", "ACTIVE"];
+            };
+            readonly daily_budget: {
+                readonly type: "number";
+                readonly description: "Cents.";
+            };
+            readonly lifetime_budget: {
+                readonly type: "number";
+                readonly description: "Cents.";
+            };
+            readonly promoted_object: {
+                readonly type: "object";
+            };
+            readonly destination_type: {
+                readonly type: "string";
+                readonly description: "e.g. ON_AD, WEBSITE, APP, MESSENGER.";
+            };
+            readonly attribution_spec: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly event_type: {
+                            readonly type: "string";
+                        };
+                        readonly window_days: {
+                            readonly type: "number";
+                        };
+                    };
+                    readonly required: readonly ["event_type", "window_days"];
+                };
+            };
+            readonly is_incremental_attribution_enabled: {
+                readonly type: "boolean";
+            };
+            readonly start_time: {
+                readonly type: "string";
+            };
+            readonly end_time: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["account_id", "campaign_id", "name", "optimization_goal", "billing_event", "targeting"];
+    };
+} | {
+    readonly name: "meta_ads_create_ad_creative";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly page_id: {
+                readonly type: "string";
+            };
+            readonly image_hash: {
+                readonly type: "string";
+                readonly description: "From meta_ads_upload_image. Required for both single and asset_feed_spec modes.";
+            };
+            readonly link: {
+                readonly type: "string";
+                readonly description: "Clickthrough URL.";
+            };
+            readonly message: {
+                readonly type: "string";
+                readonly description: "Single primary text. Mutually exclusive with messages[].";
+            };
+            readonly messages: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 primary text variants. Triggers asset_feed_spec mode if >1.";
+            };
+            readonly headline: {
+                readonly type: "string";
+                readonly description: "Single headline below the image.";
+            };
+            readonly headlines: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 headline variants. Triggers asset_feed_spec mode if >1.";
+            };
+            readonly description: {
+                readonly type: "string";
+                readonly description: "Single sub-description.";
+            };
+            readonly descriptions: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 description variants. Triggers asset_feed_spec mode if >1.";
+            };
+            readonly call_to_action: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly description: "e.g. SIGN_UP, DOWNLOAD, LEARN_MORE, SHOP_NOW.";
+                    };
+                    readonly value: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly link: {
+                                readonly type: "string";
+                            };
+                            readonly lead_gen_form_id: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                readonly required: readonly ["type"];
+            };
+            readonly lead_gen_form_id: {
+                readonly type: "string";
+                readonly description: "Shortcut: builds CTA={type:SIGN_UP, value:{lead_gen_form_id}}.";
+            };
+            readonly url_tags: {
+                readonly type: "string";
+                readonly description: "Query-string fragment for tracking, no leading ?. Use {{ad.name}} macros.";
+            };
+            readonly instagram_actor_id: {
+                readonly type: "string";
+                readonly description: "Optional IG business account for cross-posting.";
+            };
+        };
+        readonly required: readonly ["account_id", "name", "page_id", "link"];
+    };
+} | {
+    readonly name: "meta_ads_create_ad";
+    readonly description: "Create a Meta ad attached to an ad set and creative. Defaults to PAUSED.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly adset_id: {
+                readonly type: "string";
+            };
+            readonly creative_id: {
+                readonly type: "string";
+            };
+            readonly status: {
+                readonly type: "string";
+                readonly enum: readonly ["PAUSED", "ACTIVE"];
+            };
+        };
+        readonly required: readonly ["account_id", "name", "adset_id", "creative_id"];
+    };
+} | {
+    readonly name: "meta_ads_upload_image";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly image_bytes: {
+                readonly type: "string";
+                readonly description: "Base64-encoded image data.";
+            };
+            readonly image_path: {
+                readonly type: "string";
+                readonly description: "Local file path to read.";
+            };
+        };
+        readonly required: readonly ["account_id"];
+    };
+} | {
+    readonly name: "meta_ads_create_leadgen_form";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly page_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly locale: {
+                readonly type: "string";
+                readonly description: "Default en_US.";
+            };
+            readonly form_type: {
+                readonly type: "string";
+                readonly enum: readonly ["MORE_VOLUME", "HIGHER_INTENT"];
+            };
+            readonly block_display_for_non_targeted_viewer: {
+                readonly type: "boolean";
+            };
+            readonly privacy_policy: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                    readonly link_text: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["url"];
+            };
+            readonly context_card: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly style: {
+                        readonly type: "string";
+                        readonly enum: readonly ["PARAGRAPH_STYLE", "LIST_STYLE"];
+                    };
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly content: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly button_text: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["style", "title", "content"];
+            };
+            readonly questions: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly type: {
+                            readonly type: "string";
+                        };
+                        readonly key: {
+                            readonly type: "string";
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly options: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly value: {
+                                        readonly type: "string";
+                                    };
+                                    readonly key: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly required: readonly ["value", "key"];
+                            };
+                        };
+                    };
+                    readonly required: readonly ["type"];
+                };
+            };
+            readonly thank_you_page: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly body: {
+                        readonly type: "string";
+                    };
+                    readonly button_text: {
+                        readonly type: "string";
+                    };
+                    readonly button_type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["VIEW_WEBSITE", "CALL_BUSINESS", "MESSAGE_BUSINESS"];
+                    };
+                    readonly website_url: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["title", "body", "button_text", "button_type"];
+            };
+            readonly follow_up_action_url: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["page_id", "name", "privacy_policy", "questions", "thank_you_page"];
+    };
+} | {
+    readonly name: "meta_ads_create_custom_audience";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly description: {
+                readonly type: "string";
+            };
+            readonly customer_file_source: {
+                readonly type: "string";
+                readonly enum: readonly ["USER_PROVIDED_ONLY", "PARTNER_PROVIDED_ONLY", "BOTH_USER_AND_PARTNER_PROVIDED"];
+            };
+        };
+        readonly required: readonly ["account_id", "name"];
+    };
+} | {
+    readonly name: "meta_ads_upload_users_to_audience";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly audience_id: {
+                readonly type: "string";
+            };
+            readonly users: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly email: {
+                            readonly type: "string";
+                        };
+                        readonly phone: {
+                            readonly type: "string";
+                        };
+                        readonly first_name: {
+                            readonly type: "string";
+                        };
+                        readonly last_name: {
+                            readonly type: "string";
+                        };
+                        readonly country: {
+                            readonly type: "string";
+                        };
+                        readonly zip: {
+                            readonly type: "string";
+                        };
+                        readonly city: {
+                            readonly type: "string";
+                        };
+                        readonly state: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly schema: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly enum: readonly ["EMAIL", "PHONE", "FN", "LN", "COUNTRY", "ZIP", "CT", "ST", "DOBY", "GEN", "MADID"];
+                };
+            };
+            readonly session_id: {
+                readonly type: "number";
+            };
+            readonly batch_size: {
+                readonly type: "number";
+                readonly description: "Default 1000, max 10000.";
+            };
+        };
+        readonly required: readonly ["audience_id", "users"];
+    };
+} | {
+    readonly name: "meta_ads_create_lookalike_audience";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly account_id: {
+                readonly type: "string";
+            };
+            readonly name: {
+                readonly type: "string";
+            };
+            readonly origin_audience_id: {
+                readonly type: "string";
+            };
+            readonly country: {
+                readonly type: "string";
+                readonly description: "ISO 3166-1 alpha-2.";
+            };
+            readonly ratio: {
+                readonly type: "number";
+            };
+            readonly description: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["account_id", "name", "origin_audience_id", "country"];
+    };
+} | {
+    readonly name: "meta_ads_update_object_status";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly object_id: {
+                readonly type: "string";
+                readonly description: "Campaign, ad set, or ad id.";
+            };
+            readonly status: {
+                readonly type: "string";
+                readonly enum: readonly ["PAUSED", "ACTIVE", "ARCHIVED"];
+            };
+        };
+        readonly required: readonly ["object_id", "status"];
+    };
+} | {
+    readonly name: "meta_ads_update_budget";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly object_id: {
+                readonly type: "string";
+                readonly description: "Campaign or ad set id.";
+            };
+            readonly daily_budget: {
+                readonly type: "number";
+                readonly description: "Cents.";
+            };
+            readonly lifetime_budget: {
+                readonly type: "number";
+                readonly description: "Cents.";
+            };
+        };
+        readonly required: readonly ["object_id"];
+    };
+} | {
+    readonly name: "meta_ads_delete_object";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly object_id: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["object_id"];
+    };
+} | {
+    readonly name: "meta_ads_swap_ad_lead_form";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+            readonly new_form_id: {
+                readonly type: "string";
+                readonly description: "New lead_gen_form_id to bind.";
+            };
+            readonly cta_type: {
+                readonly type: "string";
+                readonly description: string;
+            };
+            readonly dry_run: {
+                readonly type: "boolean";
+                readonly description: "If true, return a diff without writing. Default false.";
+            };
+        };
+        readonly required: readonly ["ad_id", "new_form_id"];
+    };
+} | {
+    readonly name: "meta_ads_rebind_ad_creative";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+            readonly creative_id: {
+                readonly type: "string";
+                readonly description: "New creative_id to bind to the ad.";
+            };
+            readonly dry_run: {
+                readonly type: "boolean";
+                readonly description: "If true, return a diff without writing. Default false.";
+            };
+            readonly force: {
+                readonly type: "boolean";
+                readonly description: "Bypass the asset_customization_rules safety check. Use only when intentionally replacing per-placement image rules.";
+            };
+        };
+        readonly required: readonly ["ad_id", "creative_id"];
+    };
+} | {
+    readonly name: "meta_ads_edit_creative_text";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly ad_id: {
+                readonly type: "string";
+                readonly description: "Meta ad id (numeric).";
+            };
+            readonly messages: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 primary text variants. Replaces the entire bodies[] array.";
+            };
+            readonly headlines: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 headline variants. Replaces the entire titles[] array.";
+            };
+            readonly descriptions: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Up to 5 description variants. Replaces the entire descriptions[] array.";
+            };
+            readonly dry_run: {
+                readonly type: "boolean";
+                readonly description: "If true, return a diff without writing.";
+            };
+            readonly force: {
+                readonly type: "boolean";
+                readonly description: "Bypass the label-orphaning safety check (only for DCO-style ads with labeled text).";
+            };
+        };
+        readonly required: readonly ["ad_id"];
+    };
+})[];
+//# sourceMappingURL=toolDefinitions.d.ts.map