Get install instructions
get_install_instructionsGet step-by-step instructions the user follows on their website or in their ad platform's ads manager, for one task: installing PixelFlow, adding UTM parameters to ad links, removing an ad platform's own pixel code (such as the Facebook pixel) that was added before PixelFlow and would count events twice, or removing PixelFlow. Steps are written for the site's platform, and install steps include this site's code snippet, ready to paste. Use it when the user is ready to install PixelFlow, or asks how to add UTM parameters, remove a duplicate pixel, or uninstall.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"site_id": "<site_id>",
"task": "<task>"
},
"name": "get_install_instructions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task | Yes | What the instructions are for. install: add PixelFlow to the site. add_utm: add UTM parameters to ad links so conversions are attributed to campaigns. remove_duplicate_pixel: find and remove an ad platform pixel already on the site. uninstall: remove PixelFlow from the site. | |
| phase | No | install on platforms with a PixelFlow plugin only. connect (default): install the plugin and sign in. activate: the remaining steps after an ad platform is connected. Ignored on other platforms. | |
| site_id | Yes | Site to act on, as returned by list_sites. | |
| other_platform | No | Platform the site runs on when its saved platform is other, such as kajabi, hubspot, or html. Omit for the generic steps. An unknown name is refused with the supported list. Refused when the saved platform is not other. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| docs | Yes | Help articles for this result: `title` (string) and `url` (string, uri). | |
| task | Yes | The task the instructions are for. | |
| steps | Yes | Numbered steps for this task on this platform. | |
| snippet | Yes | HTML snippet with this site's public site id and key, to paste into the site. null on platforms with a PixelFlow plugin and for tasks other than install. | |
| platform | Yes | Platform the steps are written for, such as webflow. | |
| instruction | Yes | One-sentence summary of what to do. | |
| utm_templates | Yes | add_utm only: one UTM template per ad platform, to paste into the ad's URL parameters: `ad_platform` (string) and `template` (string). | |
| other_platform | Yes | Platform the steps are written for when the saved platform is other, such as kajabi. null when it was not passed or the saved platform is not other. | |
| rules_to_follow | Yes | How to show the snippet to the user; follow them when you present it. null when the result has no snippet. | |
| native_pixel_search | Yes | remove_duplicate_pixel, and install with phase activate: text to search the site's code for to find an ad platform pixel already on the site. | |
| supported_other_platforms | Yes | Platforms with their own steps when the saved platform is other, such as kajabi or html. Pass one as `other_platform`. null when the saved platform is not other. |