Skip to main content
Glama

PushNotif Official MCP Server

configure_inapp_banner

Idempotent

Configure and publish an on-site In-App Popup or Banner (center modal, top sticky bar, or bottom slide-in toast) rendered inside the website by the PushNotif SDK without requiring browser push permission. Use this tool for visual in-page promos and announcements; do not use it for OS lock-screen notifications (use send_push_notification instead). Prerequisite: call list_apps first to obtain app_id. Requires PUSHNOTIF_API_KEY; saving configuration is idempotent and costs 0 credits, while each live visitor display deducts 1 credit (inapp_trigger controls when the banner fires—such as 'scroll_50' for 50% page scroll or 'event:add_to_cart' for custom DOM events—combined with inapp_freq to cap repeat impressions per visitor). Returns JSON { ok, app_id, inapp_enabled, inapp_style, inapp_trigger, inapp_freq }.

Input Schema

NameRequiredDescriptionDefault
app_idYesTarget application ID in format app_xxxx (obtain from list_apps)
inapp_bodyYesBanner supporting message text (1 to 240 characters)
inapp_freqNoPer-visitor frequency cap: 'once_forever' (one-time announcement per visitor, never shown again), 'once_per_session' (default), 'once_per_day', 'cooldown_3h', 'cooldown_12h', 'once_per_week', or 'always'
inapp_styleNoVisual layout: 'modal' (center dialog), 'top_bar' (sticky top ribbon), or 'bottom_slide' (corner slide-in toast)
inapp_titleYesBanner headline text (1 to 100 characters)
segment_tagNoOptional target segment/merchant tag (e.g., 'seblak-nearby') to display a dedicated In-App Banner on pages matching that tag under a single shared App ID (default: 'all' for global fallback)
inapp_accentNoOptional 6-digit hex color code for the CTA button and accent border (default: '#0058BE')
inapp_cta_urlNoOptional HTTPS destination URL opened when the CTA button is clicked
inapp_enabledNoSet true to publish the banner live on the website, or false to pause it (default: true)
inapp_triggerNoTrigger condition: 'immediate' (default), 'delay_5s', 'delay_10s', 'scroll_50', 'scroll_80', or custom DOM event 'event:<name>'
inapp_cta_textNoOptional CTA button label (must be paired with inapp_cta_url to render a clickable action button)
inapp_image_urlNoOptional HTTPS image/poster URL (supports transparent PNG/WEBP)
inapp_image_sizeNoOptional poster width preset when using image_only: 'compact', 'standard' (default), 'large', 'xl', or 'full'
inapp_custom_htmlNoOptional raw HTML card markup when inapp_template_id is ai_custom (renders up to 96vw x 94vh)
inapp_template_idNoOptional template preset: 'default', 'ai_custom' (custom HTML card), 'voucher_copy', 'flash_timer', 'feature_grid', or 'event_invite'
inapp_image_transparentNoSet true when using a transparent PNG/WEBP poster in image_only style so no card box is rendered

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / properties / inapp_custom_html
      Added value: +{
      +  "description": "Optional raw HTML card markup when inapp_template_id is ai_custom (renders up to 96vw x 94vh)",
      +  "type": "string"
      +}
    • addedInput schema / properties / inapp_image_size
      Added value: +{
      +  "description": "Optional poster width preset when using image_only: 'compact', 'standard' (default), 'large', 'xl', or 'full'",
      +  "type": "string"
      +}
    • addedInput schema / properties / inapp_image_transparent
      Added value: +{
      +  "description": "Set true when using a transparent PNG/WEBP poster in image_only style so no card box is rendered",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / inapp_image_url
      Added value: +{
      +  "description": "Optional HTTPS image/poster URL (supports transparent PNG/WEBP)",
      +  "type": "string"
      +}
    • addedInput schema / properties / inapp_template_id
      Added value: +{
      +  "description": "Optional template preset: 'default', 'ai_custom' (custom HTML card), 'voucher_copy', 'flash_timer', 'feature_grid', or 'event_invite'",
      +  "type": "string"
      +}
    • addedInput schema / properties / segment_tag
      Added value: +{
      +  "description": "Optional target segment/merchant tag (e.g., 'seblak-nearby') to display a dedicated In-App Banner on pages matching that tag under a single shared App ID (default: 'all' for global fallback)",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations: discloses PUSHNOTIF_API_KEY requirement, the cost model (0 credits to save, 1 credit per live visitor display), idempotent save behavior, and the exact return payload shape. These are non-obvious operational facts an agent cannot get from the structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose and sibling exclusion, then prerequisite, cost, and return shape in a logical order with zero filler. It is a single dense block, though, and the trigger/freq parenthetical pushes toward the edge of readability for a 16-parameter tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 16-parameter mutation tool with no output schema, the description covers the prerequisite call, auth key, credit cost, idempotency, and even the return JSON keys. An agent has everything needed to invoke it correctly and predict the response.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning by explaining the interplay between inapp_trigger and inapp_freq (trigger fires the banner, freq caps repeat impressions) and gives concrete trigger examples like 'scroll_50' and 'event:add_to_cart'. It does not explain segment_tag or the template/image interaction, which the schema carries alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb+resource (configure and publish an In-App Popup/Banner) and enumerates the three concrete render modes (center modal, top sticky bar, bottom slide-in toast) plus the rendering mechanism (PushNotif SDK, no browser push permission). It explicitly excludes OS lock-screen notifications and names send_push_notification as the sibling for that case.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

States when to use it ('visual in-page promos and announcements'), when not to ('do not use it for OS lock-screen notifications'), the substitute (send_push_notification), and a hard prerequisite ('call list_apps first to obtain app_id'). Nothing key is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.