List AEM Blocks
list_blocksRetrieve all available AEM blocks with metadata including descriptions, file paths, and counts from blocks.json files.
Instructions
List all available AEM blocks with metadata from blocks.json
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- index.js:160-197 (handler)The asynchronous handler function for the 'list_blocks' tool. It maps the BLOCKS_METADATA array into a structured format and returns it as JSON text content, with error handling.
async () => { try { const blocks = BLOCKS_METADATA.map(block => ({ name: block.name, description: block.description, jsFile: block.js_file, cssFile: block.css_file, helperFile: block.helper_file || null, hasCSS: !!block.css_file, hasJS: !!block.js_file, hasHelper: !!block.helper_file, fileCount: [block.js_file, block.css_file, block.helper_file].filter(Boolean).length })); return { content: [{ type: "text", text: JSON.stringify({ blocks, total: blocks.length, mode: 'metadata-only', message: 'Using embedded blocks metadata for analysis', source: 'embedded-data' }, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: JSON.stringify({ error: 'Failed to list blocks', details: error.message }, null, 2) }] }; } } - index.js:155-198 (registration)The server.registerTool call that registers the 'list_blocks' tool, specifying its title, description, and handler function.
server.registerTool("list_blocks", { title: "List AEM Blocks", description: "List all available AEM blocks with metadata from blocks.json", }, async () => { try { const blocks = BLOCKS_METADATA.map(block => ({ name: block.name, description: block.description, jsFile: block.js_file, cssFile: block.css_file, helperFile: block.helper_file || null, hasCSS: !!block.css_file, hasJS: !!block.js_file, hasHelper: !!block.helper_file, fileCount: [block.js_file, block.css_file, block.helper_file].filter(Boolean).length })); return { content: [{ type: "text", text: JSON.stringify({ blocks, total: blocks.length, mode: 'metadata-only', message: 'Using embedded blocks metadata for analysis', source: 'embedded-data' }, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: JSON.stringify({ error: 'Failed to list blocks', details: error.message }, null, 2) }] }; } } ); - index.js:8-106 (helper)Embedded constant array BLOCKS_METADATA containing metadata for all available AEM blocks (name, description, js_file, css_file, optional helper_file), directly used by the list_blocks handler.
const BLOCKS_METADATA = [ { "name": "Accordion", "description": "Implements an accordion UI pattern, allowing users to expand and collapse sections of content, styled with borders, padding, and transitions for visual feedback.", "js_file": `${BC_DOMAIN}/blocks/accordion/accordion.js`, "css_file": `${BC_DOMAIN}/blocks/accordion/accordion.css` }, { "name": "Cards", "description": "Displays content in a card-like format with images and text, using a grid layout for responsiveness and basic styling for borders and spacing.", "js_file": `${BC_DOMAIN}/blocks/cards/cards.js`, "css_file": `${BC_DOMAIN}/blocks/cards/cards.css` }, { "name": "Carousel", "description": "Creates a carousel or slider to showcase content, featuring navigation buttons, slide indicators, and CSS for basic layout and appearance.", "js_file": `${BC_DOMAIN}/blocks/carousel/carousel.js`, "css_file": `${BC_DOMAIN}/blocks/carousel/carousel.css` }, { "name": "Columns", "description": "Arranges content into columns, adapting to different screen sizes with CSS flexbox for layout control.", "js_file": `${BC_DOMAIN}/blocks/columns/columns.js`, "css_file": `${BC_DOMAIN}/blocks/columns/columns.css` }, { "name": "Embed", "description": "Embeds external content (videos, social posts) into a page, using placeholders and lazy loading for performance.", "js_file": `${BC_DOMAIN}/blocks/embed/embed.js`, "css_file": `${BC_DOMAIN}/blocks/embed/embed.css` }, { "name": "Footer", "description": "Loads and displays footer content, fetching it as a fragment and applying basic styling for background color and font size.", "js_file": `${BC_DOMAIN}/blocks/footer/footer.js`, "css_file": `${BC_DOMAIN}/blocks/footer/footer.css` }, { "name": "Form", "description": "Generates forms from JSON definitions, handling submissions and confirmations, with CSS for structuring fields and basic input styling.", "js_file": `${BC_DOMAIN}/blocks/form/form.js`, "css_file": `${BC_DOMAIN}/blocks/form/form.css`, "helper_file": `${BC_DOMAIN}/blocks/form/form-fields.js` }, { "name": "Fragment", "description": "Includes content from another page fragment into the current page.", "js_file": `${BC_DOMAIN}/blocks/fragment/fragment.js`, "css_file": `${BC_DOMAIN}/blocks/fragment/fragment.css` }, { "name": "Header", "description": "Loads and displays header content, fetching it as a fragment and applying CSS for layout and navigation.", "js_file": `${BC_DOMAIN}/blocks/header/header.js`, "css_file": `${BC_DOMAIN}/blocks/header/header.css` }, { "name": "Hero", "description": "Presents a hero section with a large image and heading, using CSS for positioning and basic styling.", "js_file": `${BC_DOMAIN}/blocks/hero/hero.js`, "css_file": `${BC_DOMAIN}/blocks/hero/hero.css` }, { "name": "Modal", "description": "Creates modal dialogs that can be opened via links, styled with CSS for appearance and positioning.", "js_file": `${BC_DOMAIN}/blocks/modal/modal.js`, "css_file": `${BC_DOMAIN}/blocks/modal/modal.css` }, { "name": "Quote", "description": "Displays a quote with an optional attribution, styled with CSS for quotation marks and alignment.", "js_file": `${BC_DOMAIN}/blocks/quote/quote.js`, "css_file": `${BC_DOMAIN}/blocks/quote/quote.css` }, { "name": "Search", "description": "Implements a search feature with a search box and results display, using CSS for layout and highlighting search terms.", "js_file": `${BC_DOMAIN}/blocks/search/search.js`, "css_file": `${BC_DOMAIN}/blocks/search/search.css` }, { "name": "Table", "description": "Renders data in a tabular format, providing options for header display, striping, and borders via CSS classes.", "js_file": `${BC_DOMAIN}/blocks/table/table.js`, "css_file": `${BC_DOMAIN}/blocks/table/table.css` }, { "name": "Tabs", "description": "Creates a tabbed interface for organizing content into panels, using CSS for layout and basic styling of tabs and panels.", "js_file": `${BC_DOMAIN}/blocks/tabs/tabs.js`, "css_file": `${BC_DOMAIN}/blocks/tabs/tabs.css` }, { "name": "Video", "description": "Embeds videos from various sources (YouTube, Vimeo, local files), using placeholders and lazy loading for performance, with CSS for basic layout and styling.", "js_file": `${BC_DOMAIN}/blocks/video/video.js`, "css_file": `${BC_DOMAIN}/blocks/video/video.css` } ];