Drop-in helper reference
The drop-in helper exposes 20 tools across four categories. Each tool reads from a registry generated from drop-in source code, so results always reflect the current API surface not training data.
For installation and editor configuration, see Drop-in helper. For connection and configuration troubleshooting, see Drop-in helper FAQ.
Discovery tools
Section titled “Discovery tools”These tools answer questions about what exists in the drop-in ecosystem: containers, slots, events, API functions, GraphQL operations, design tokens, i18n keys, and data models.
analyze_project
Section titled “analyze_project”Scans a merchant project and reports which drop-ins are installed, which blocks are present, and the current configuration state.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
Example: “Use the drop-in helper to analyze my project at /Users/me/my-storefront”
list_containers
Section titled “list_containers”Lists available containers for one or all drop-ins, including their props and slot names.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart). Omit to list all. |
Example: “What containers does the checkout drop-in expose?”
list_slots
Section titled “list_slots”Lists slots for drop-in containers, including context types and available methods.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart). Omit to list all. |
container | string | No | Container name (for example, CartSummaryList). Requires dropin. |
Example: “What slots does the MiniCart container have?”
list_events
Section titled “list_events”Lists event bus events with emitters, consumers, and payload types, optionally filtered by drop-in and direction.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart) |
direction | emitted | consumed | all | No | Filter by direction. Default: all |
Example: “What events does the cart drop-in emit?”
list_api_functions
Section titled “list_api_functions”Lists public API functions for one or all drop-ins, including their signatures and parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart). Omit to list all. |
Example: “What API functions does the account drop-in expose?”
list_graphql_queries
Section titled “list_graphql_queries”Lists GraphQL queries, mutations, and extensible fragments for drop-ins.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart). Omit to list all. |
type | query | mutation | No | Filter by operation type |
name | string | No | Case-insensitive substring search on operation or fragment name |
Example: “What GraphQL mutation does checkout use to place an order?”
list_design_tokens
Section titled “list_design_tokens”Lists CSS custom properties (design tokens) by category.
| Parameter | Type | Required | Description |
|---|---|---|---|
category | string | No | Token category: colors, typography, spacing, shapes, grid. Omit to list all. |
Example: “What CSS tokens control button colors?”
list_i18n_keys
Section titled “list_i18n_keys”Lists i18n dictionary keys and their default English values, filterable by drop-in, container, or substring.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-checkout). Omit to search all. |
query | string | No | Substring filter applied to key paths and values. Case-insensitive. |
containerName | string | No | Filter to keys used by a specific container (for example, MiniCart). |
Example: “What are all the i18n keys for the CartSummaryList container?”
list_models
Section titled “list_models”Lists model definitions (interfaces and type aliases) from drop-in source files.
| Parameter | Type | Required | Description |
|---|---|---|---|
dropin | string | No | Drop-in name (for example, storefront-cart) |
model | string | No | Specific model name (for example, CartModel, Price). Returns the full definition. |
Example: “What is the CartModel type definition?”
Code generation tools
Section titled “Code generation tools”These tools generate working boilerplate for blocks, extensions, slots, and event handlers based on your request.
scaffold_block
Section titled “scaffold_block”Generates an AEM block with drop-in container imports, layout, and slot stubs.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
blockName | string | Yes | Block name (for example, commerce-custom-cart). Used as folder and file name. |
dropin | string | No | Primary drop-in for single-dropin mode. Requires containers. |
containers | string[] | No | Container names for single-dropin mode. Requires dropin. |
containersByDropin | object | No | Multi-dropin mode: map of drop-in name to container names |
slots | object | No | Slots per container to include as stubs |
withEvents | boolean | No | Include event bus wiring boilerplate. Default: false. |
Example: “Scaffold a block that uses CartSummaryList and MiniCart from the cart drop-in”
scaffold_extension
Section titled “scaffold_extension”Generates a checkout extension with selected hooks, an extension manager, and an index file.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
extensionName | string | Yes | Human-readable name (for example, Stripe Payment) |
extensionId | string | Yes | Unique ID used as folder name and id field (for example, stripe-payment) |
hooks | string[] | Yes | Hook names to implement (for example, ["checkout/payment-methods"]) |
externalScripts | string[] | No | External script URLs to load |
externalStyles | string[] | No | External stylesheet URLs to load |
Example: “Create a checkout extension for a custom payment method called Stripe”
scaffold_slot
Section titled “scaffold_slot”Generates production-ready slot implementation boilerplate for a specific container slot.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
containerName | string | Yes | Container name (for example, MiniCart) |
slotName | string | Yes | Slot name to scaffold (for example, Thumbnail) |
dropin | string | No | Drop-in package name. Provide to resolve ambiguity when the same container name exists in multiple drop-ins. |
Example: “Generate a slot implementation for the Thumbnail slot in CartSummaryList”
suggest_slot_implementation
Section titled “suggest_slot_implementation”Suggests slot implementation code for a UI customization request on an existing block.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
request | string | Yes | What you want to achieve (for example, "Add a loyalty points badge next to the price in cart") |
blockName | string | Yes | Block name (for example, commerce-cart) |
Example: “Add a custom banner above the place order button in my commerce-checkout block”
suggest_event_handler
Section titled “suggest_event_handler”Suggests event handler code for cross-drop-in interactions based on a natural-language request.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
request | string | Yes | What you want to achieve (for example, "Show a popup when an order is placed") |
Example: “When the cart emits an item removed event, update a custom loyalty points counter”
explain_event_flow
Section titled “explain_event_flow”Traces the full lifecycle of an event: who emits it, who consumes it, the payload type, and ready-to-use code for both sides.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventName | string | Yes | Exact or partial event name (for example, cart/data). Prefix matching is supported. |
dropin | string | No | Filter results to events involving a specific drop-in |
Example: “Explain the full lifecycle of the cart/data event”
Health and upgrade tools
Section titled “Health and upgrade tools”These tools inspect your project against the registry and report issues, available upgrades, and migration notes.
check_block_health
Section titled “check_block_health”Validates drop-in usage in one or all blocks against the registry. Detects invalid containers, unknown props, missing slots, renamed events, and removed API functions. Supports a fixer mode that includes a concrete fix suggestion for each finding.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant project root |
block | string | No | Block directory name (for example, commerce-cart). Omit to scan all blocks. |
fix | boolean | No | When true, each finding includes a concrete fix suggestion |
Example: “Check the health of my commerce-checkout block and suggest fixes for any issues”
check_config
Section titled “check_config”Validates a merchant project’s configuration files: config.json, package.json, dropin integrity, and initializers.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
Example: “Check the configuration of my storefront project”
get_upgrade_diff
Section titled “get_upgrade_diff”Compares installed drop-in versions against the registry and reports available upgrades, unused containers, and migration notes.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectDir | string | Yes | Absolute path to the merchant storefront project root |
Example: “Am I using the latest drop-in versions? What do I need to update?”
Documentation tools
Section titled “Documentation tools”These tools search across documentation, SDK references, working code examples, and GraphQL schemas.
search_docs
Section titled “search_docs”Searches local documentation snapshots, SDK references, and working code examples. Always available no external authentication required.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search query (for example, "CORS setup", "cart slots") |
section | string | No | Limit search to a specific documentation section (for example, "setup", "dropins/cart") |
maxResults | number | No | Maximum results to return. Default: 10. |
includeContent | boolean | No | Include full page content. Default: false (returns snippets). |
Example: “Search the docs for multi-step checkout setup”
search_commerce_docs
Section titled “search_commerce_docs”AI-powered semantic search across the full Adobe Commerce documentation. Requires the Adobe I/O CLI (aio auth login).
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Natural-language search query |
Example: “How do I configure reCAPTCHA for the checkout drop-in?”