Skip to content

Commit bbecc64

Browse files
Phil Whittakerclaude
andcommitted
Reorganize Developer MCP best practices documentation
- Update SUMMARY.md to reflect new best practices structure - Move best-practice.md content into organized subdirectory - Improve documentation navigation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 15f8113 commit bbecc64

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed

16/umbraco-cms/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,11 +367,12 @@
367367
* [Claude Code](reference/developer-mcp/host-setup/claude-code.md)
368368
* [Cursor](reference/developer-mcp/host-setup/cursor.md)
369369
* [GitHub Copilot](reference/developer-mcp/host-setup/github-copilot.md)
370+
* [Best Practice](reference/developer-mcp/best-practice/README.md)
371+
* [Example Instruction File](reference/developer-mcp/best-practice/example-instructions.md)
370372
* [Configuration](reference/developer-mcp/configuration.md)
371373
* [Available Tools](reference/developer-mcp/available-tools.md)
372374
* [Excluded Tools](reference/developer-mcp/excluded-tools.md)
373375
* [Use Cases and Scenarios](reference/developer-mcp/scenarios.md)
374-
* [Best Practice](reference/developer-mcp/best-practice.md)
375376
* [API versioning and OpenAPI](reference/api-versioning-and-openapi.md)
376377
* [Searching](reference/searching/README.md)
377378
* [Examine](reference/searching/examine/README.md)

16/umbraco-cms/reference/developer-mcp/best-practice.md renamed to 16/umbraco-cms/reference/developer-mcp/best-practice/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ In some cases, it’s helpful to include a rules or instruction file that explai
8989

9090
This helps the LLM reason more effectively about how to use the Developer MCP Server — especially when multiple tools are involved.
9191

92+
View an example [instruction file](./example-instructions.md).
93+
9294
## Crafting Good Prompts
9395

9496
While the Developer MCP Server provides structured access to tools, your results still depend heavily on **how well you prompt the model**. A good prompt sets clear intent, scope, and expectations — and helps the LLM make the most of the tools available to it.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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

Comments
 (0)