|
| 1 | +--- |
| 2 | +description: Get the most out of the Umbraco CMS developer MCP server |
| 3 | +--- |
| 4 | + |
| 5 | +# Example instructions file |
| 6 | + |
| 7 | +Created by [Tom Madden](https://github.com/TwoMoreThings) |
| 8 | + |
| 9 | +# Umbraco Development Guidelines (v16.2.0) |
| 10 | + |
| 11 | +## Tool Usage |
| 12 | + |
| 13 | +- Use Context7 to retrieve Umbraco v16.2.0 documentation |
| 14 | +- Use the Umbraco MCP tool for ALL Umbraco interactions - make multiple calls as needed, never try to optimize with bulk operations |
| 15 | +- Use create-media MCP tool for media items, referencing files in wwwroot/media/my-folder |
| 16 | + |
| 17 | +## Content Structure |
| 18 | + |
| 19 | +- Always use Block List over Block Grid for composable pages |
| 20 | +- All navigable content pages must be nested under the Home page |
| 21 | +- All Content Type properties must belong to either a tab or a group |
| 22 | + |
| 23 | +## Block List Configuration |
| 24 | + |
| 25 | +- Items require a contentKey in UUID/GUID format |
| 26 | + - Define labels using the Umbraco Flavored Markdown format, e.g. {umbValue: propertyAlias} (NOT {{$propertyAlias}}) |
| 27 | + |
| 28 | +## Templates & Content Types |
| 29 | + |
| 30 | +- For web page content types (non-element types): |
| 31 | + - Create corresponding template via Management API first |
| 32 | + - Assign template to content type |
| 33 | + - Set as default template |
| 34 | + |
| 35 | +## Data Types |
| 36 | + |
| 37 | +- Save new Data Types in 'Custom Data Types' folder |
| 38 | +- Use 'Rich Text Editor [Tiptap]' for formatted text content |
| 39 | +- Use Link Picker instead of multiple TextString properties for links |
| 40 | + |
| 41 | +## File Handling |
| 42 | + |
| 43 | +- Never modify file metadata/dates (preserves Git change tracking) |
| 44 | +- Add static assets to wwwroot subdirectories |
| 45 | +- When downloading images, exclude favicon.png and apple-icon.png |
| 46 | +- Look for CSS/inline style images, not just src attributes |
| 47 | + |
| 48 | +## Models & Publishing |
| 49 | + |
| 50 | +- STOP and prompt user to generate models and restart site (never generate manually) |
| 51 | +- Verify the node Layout is set correctly when saving/publishing pages |
0 commit comments