You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Enhanced wording throughout README for clarity and consistency
- Fixed broken internal links to use correct relative paths
- Updated example use cases with more specific details
- Removed empty warp.md and windsurf.md host setup files
- Improved formatting and structure of JSON configuration example
- Added links to related documentation pages
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: 16/umbraco-cms/reference/developer-mcp/README.md
+37-33Lines changed: 37 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,14 @@ Instead, it runs as a standalone Node.js application that acts as an MCP server.
19
19
20
20
MCP clients—implemented inside compatible host applications such as Claude Desktop, Cursor, or Windsurf—connect to this server. When you interact with your chat-based development environment, the client communicates with the MCP Server using the Model Context Protocol (MCP).
21
21
22
-
Learn more about [Model Context Protocol (MCP)](./model-context-protocol.md)
22
+
Learn more about [Model Context Protocol (MCP)](./concepts/model-context-protocol.md)
23
23
24
24
The MCP Server, in turn, talks directly to Umbraco through the Management API. This is the same API layer that powers the Umbraco backoffice, allowing it to read from and modify the CMS.
25
25
26
26
By exposing these endpoints as MCP tools, the Developer MCP Server enables you to perform almost any backoffice action through natural language interaction with your LLM-powered chat environment.
27
27
28
28
{% hint style="info" %}
29
-
The MCP Server acts as the bridge between your Umbraco instance and your AI assistant, translating and adapting your tasks into real Management API calls.
29
+
The MCP Server acts as the bridge between your Umbraco instance and your AI assistant, translating and adapting your tasks into Management API calls.
30
30
{% endhint %}
31
31
32
32
## Who is this for?
@@ -37,32 +37,32 @@ While the Model Context Protocol (MCP) can be used for many types of solution, a
37
37
38
38
Example use cases
39
39
40
-
-**Automation of contentand models**
41
-
Automate repetitive actions such as creating or updating content, generating content models, or performing large-scale content operations directly through conversational commands.
40
+
-**Automation of content, media and schema**
41
+
Automate repetitive actions such as creating or updating content or media, generating content models, or performing large-scale content or media operations directly through conversational commands.
42
42
43
43
-**Developer quality-of-life improvements**
44
-
Speed up tasks that would otherwise take time or multiple clicks in the backoffice UI. For example, batch-moving Document Types or Data Types, cleaning up unused entities, or synchronising content structures across environments.
44
+
Speed up tasks that would otherwise take time or require numerous clicks in the backoffice UI. For example, batch-moving Document Types or Data Types, cleaning up unused entities, or synchronising content structures across environments.
45
45
46
46
-**Integration into modern development workflows**
47
47
Use the Developer MCP Server alongside other MCP servers such as Playwright MCP, Figma MCP, or GitHub MCP to streamline your end-to-end site development process.
48
48
49
49
-**Leveraging LLM reasoning**
50
-
Go beyond automation—use your LLM to understand, debug, or make better decisions. For example, ask it to interpret entries from Umbraco Logs, suggest schema changes, or explain configuration errors.
50
+
Use your LLM to understand, debug, or make better decisions. For example, ask it to interpret entries from Umbraco Logs, suggest schema changes, or explain configuration errors.
51
51
52
-
-**plus many, many more**
52
+
-[**plus many, many more**](./how-best-to-use.md)
53
53
54
54
**Not recommended for non-developers**
55
55
56
-
While it’s technically possible for non-developers to connect to Umbraco using this MCP server, we do not recommend it for the following reasons:
56
+
While it’s technically feasible for non-developers to connect to Umbraco using this MCP server, we do not recommend it for the following reasons:
57
57
58
58
-**Complex setup requirements**
59
-
The server must be run locally, and it requires a configured Umbraco user account with appropriate permissions.
59
+
This MCP server must be run locally, and it requires a configured Umbraco user account with appropriate permissions.
60
60
61
61
-**Powerful tool access**
62
62
Even for users with limited permissions, the MCP Server exposes many management-level tools. Incorrect commands could unintentionally alter or damage your Umbraco instance.
63
63
64
64
{% hint style="warning" %}
65
-
Do not connect the Developer MCP Server to a production Umbraco environment.
65
+
Do not connect the Developer MCP Server to a production Umbraco environment.
66
66
Always use a local or isolated development instance.
67
67
{% endhint %}
68
68
@@ -72,13 +72,13 @@ We are actively working on additional MCP servers tailored to other roles—such
72
72
73
73
### Umbraco Setup
74
74
75
-
Before connecting your MCP Server, you need to create an [API User](../../fundamentals/data/users/api-users) in Umbraco. This user allows the MCP Server to communicate securely with the Management API.
75
+
Before connecting the MCP Server, you need to create an [API User](../../fundamentals/data/users/api-users.md) in Umbraco. This user allows the MCP Server to communicate securely with the Management API.
76
76
77
77
The level of access you assign to this API user determines what actions your AI agent can perform.
78
78
For example:
79
79
80
80
- A user with Editor permissions can manage and update content but cannot modify Document Types or perform administrative tasks.
81
-
- A user with Administrator permissions grants full access — including the ability to create, edit, or delete structural elements within Umbraco.
81
+
- A user with Administrator permissions grants full access — including the ability to create, edit, or delete document types, data types and more within Umbraco.
82
82
83
83
{% hint style="warning" %}
84
84
Only use a dedicated API user for MCP connections. Do not share or reuse credentials from an existing backoffice user.
@@ -88,39 +88,43 @@ Only use a dedicated API user for MCP connections. Do not share or reuse credent
88
88
89
89
Each MCP-compatible host application has its own setup process. For this reason, we provide dedicated setup guides for the main developer environments we see most often:
90
90
91
-
Claude Desktop
92
-
Claude Code
93
-
GitHub Copilot
94
-
Cursor
95
-
Windsurf
91
+
[Claude Desktop](./host-setup/claude-desktop.md)
92
+
[Claude Code](./host-setup/claude-code.md)
93
+
[GitHub Copilot](./host-setup/github-copilot.md)
94
+
[Cursor](./host-setup/cursor.md)
96
95
97
96
Although the details vary slightly, the general pattern is the same across all hosts:
Add your Umbraco MCP configuration values (from your .env file) in the appropriate section of your host setup, then restart the MCP Server — or in some cases, restart the host application itself.
114
+
Add your Umbraco MCP configuration values (Client ID, Client Secret, URL of umbraco) in the appropriate section of your host setup, then restart the MCP Server — or in some cases, restart the host application itself.
115
115
116
116
Once restarted, you’ll have access to the full suite of tools available through the Umbraco CMS Developer MCP Server.
117
117
118
118
### Choosing Your Tools
119
119
120
120
Your first step after setup should be deciding which tools you want to enable.
121
-
Some tools are grouped into collections for easier management and isolation.
121
+
All tools are grouped into collections for easier management and isolation.
122
+
123
+
[Learn more about Tool Collections](./mcp-toolkit.md)
124
+
125
+
Choosing the right tools improves how efficiently the AI communicates with Umbraco, making each conversation faster and more context-aware.
122
126
123
-
[Learn more about Tool Collections](Learn more about Tool Collections)
127
+
[Learn more about Context Engineering](./concepts/context-enginerring.md)
0 commit comments