plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "puddle",
  "version": "1.0.0",
  "description": "Securely connect your Puddle store to AI apps. Starting with analytics.",
  "author": {
    "name": "Puddle",
    "url": "https://www.puddle.co.za"
  },
  "homepage": "https://www.puddle.co.za",
  "keywords": [
    "puddle",
    "ecommerce",
    "analytics",
    "south-africa"
  ],
  "extensions": {
    "com.openai": {
      "interface": {
        "displayName": "Puddle",
        "shortDescription": "Sales analytics for your store",
        "longDescription": "Puddle is a South African ecommerce platform for online stores. This plugin lets you analyze your Puddle store's sales data in ChatGPT: get a performance overview, compare revenue by day, week or month, and find trending products. It only shares data available to the Puddle account you authorize, and it is read-only: it cannot change your store, orders, or customer data.",
        "developerName": "Puddle",
        "category": "Data & Analytics",
        "capabilities": [
          "View store analytics",
          "Compare revenue",
          "Find trending products"
        ],
        "websiteURL": "https://www.puddle.co.za",
        "supportURL": "https://www.puddle.co.za/legal/terms",
        "privacyPolicyURL": "https://www.puddle.co.za/legal/privacy",
        "termsOfServiceURL": "https://www.puddle.co.za/legal/terms",
        "defaultPrompt": [
          "What are my store's top-selling products?",
          "Compare my revenue for the last two months.",
          "Give me an overview of my Puddle store's performance."
        ],
        "brandColor": "#111827",
        "brandColorDark": "#E5E7EB",
        "composerIcon": "./assets/puddle-icon.svg",
        "logo": "./assets/puddle-icon.svg"
      },
      "review": {
        "demo_recording_url": "https://clips.puddle.co.za/s/3kwx6wyc8bg4m4y",
        "test_cases": {
          "positive": [
            {
              "description": "Get a store performance overview",
              "prompt": "Give me an overview of my store's performance.",
              "tools_triggered": "get_comprehensive_analytics",
              "expected_behavior": "Returns analytics available to the authorized Puddle account, including revenue, orders, customers, products, stock, and fulfillment where available."
            },
            {
              "description": "Find trending products",
              "prompt": "What products are trending in my store?",
              "tools_triggered": "get_trending_products",
              "expected_behavior": "Returns sales and view-based trending product data for the authorized store."
            },
            {
              "description": "Compare daily revenue",
              "prompt": "Compare my daily revenue from 1 September 2026 through 30 September 2026.",
              "tools_triggered": "get_revenue_comparison",
              "expected_behavior": "Returns a daily revenue comparison for the requested dates."
            },
            {
              "description": "Compare weekly revenue",
              "prompt": "Show my weekly revenue for August 2026.",
              "tools_triggered": "get_revenue_comparison",
              "expected_behavior": "Returns weekly revenue data for the requested date range."
            },
            {
              "description": "Request a bounded analytics period",
              "prompt": "Summarize my store analytics from 1 September 2026 through 30 September 2026.",
              "tools_triggered": "get_comprehensive_analytics",
              "expected_behavior": "Returns the authorized store's analytics for the supplied period without changing account data."
            }
          ],
          "negative": [
            {
              "description": "Unsupported store mutation",
              "prompt": "Change the price of my best-selling product."
            },
            {
              "description": "Unsupported financial action",
              "prompt": "Refund my most recent order."
            },
            {
              "description": "Unauthorized store access",
              "prompt": "Show analytics for a Puddle store I do not have permission to access."
            }
          ]
        },
        "commerce": false,
        "commerce_description": "This read-only plugin does not sell products or process payments."
      },
      "publication": {
        "release_notes": "Initial release: Puddle in ChatGPT, starting with secure, read-only store analytics."
      },
      "apps": "./.app.json"
    }
  }
}