Skip to content

Commit 69c68b7

Browse files
Phil Whittakerclaude
andcommitted
Improve README and remove empty host setup files
- 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]>
1 parent 98e604a commit 69c68b7

File tree

3 files changed

+37
-33
lines changed

3 files changed

+37
-33
lines changed

16/umbraco-cms/reference/developer-mcp/README.md

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Instead, it runs as a standalone Node.js application that acts as an MCP server.
1919

2020
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).
2121

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)
2323

2424
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.
2525

2626
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.
2727

2828
{% 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.
3030
{% endhint %}
3131

3232
## Who is this for?
@@ -37,32 +37,32 @@ While the Model Context Protocol (MCP) can be used for many types of solution, a
3737

3838
Example use cases
3939

40-
- **Automation of content and 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.
4242

4343
- **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.
4545

4646
- **Integration into modern development workflows**
4747
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.
4848

4949
- **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.
5151

52-
- **plus many, many more**
52+
- [**plus many, many more**](./how-best-to-use.md)
5353

5454
**Not recommended for non-developers**
5555

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:
5757

5858
- **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.
6060

6161
- **Powerful tool access**
6262
Even for users with limited permissions, the MCP Server exposes many management-level tools. Incorrect commands could unintentionally alter or damage your Umbraco instance.
6363

6464
{% 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.
6666
Always use a local or isolated development instance.
6767
{% endhint %}
6868

@@ -72,13 +72,13 @@ We are actively working on additional MCP servers tailored to other roles—such
7272

7373
### Umbraco Setup
7474

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.
7676

7777
The level of access you assign to this API user determines what actions your AI agent can perform.
7878
For example:
7979

8080
- 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.
8282

8383
{% hint style="warning" %}
8484
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
8888

8989
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:
9090

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)
9695

9796
Although the details vary slightly, the general pattern is the same across all hosts:
9897

9998
``` json
100-
"umbraco-mcp": {
101-
"command": "npx",
102-
"args": ["@umbraco-cms/mcp-dev@beta"],
103-
"env": {
104-
"NODE_TLS_REJECT_UNAUTHORIZED": "0",
105-
"UMBRACO_CLIENT_ID": "umbraco-back-office-mcp",
106-
"UMBRACO_CLIENT_SECRET": "1234567890",
107-
"UMBRACO_BASE_URL": "https://localhost:44391",
108-
"UMBRACO_INCLUDE_TOOL_COLLECTIONS": "culture,document,media",
109-
"UMBRACO_EXCLUDE_TOOLS": "delete-document,empty-recycle-bin"
110-
}
111-
}
99+
{
100+
"umbraco-mcp": {
101+
"command": "npx",
102+
"args": ["@umbraco-cms/mcp-dev@beta"],
103+
"env": {
104+
"NODE_TLS_REJECT_UNAUTHORIZED": "0",
105+
"UMBRACO_CLIENT_ID": "umbraco-back-office-mcp",
106+
"UMBRACO_CLIENT_SECRET": "1234567890",
107+
"UMBRACO_BASE_URL": "https://localhost:12345",
108+
}
109+
}
110+
}
111+
112112
```
113113

114-
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.
115115

116116
Once restarted, you’ll have access to the full suite of tools available through the Umbraco CMS Developer MCP Server.
117117

118118
### Choosing Your Tools
119119

120120
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.
122126

123-
[Learn more about Tool Collections](Learn more about Tool Collections)
127+
[Learn more about Context Engineering](./concepts/context-enginerring.md)
124128

125129
### Why Use npx?
126130

@@ -136,7 +140,7 @@ npm install -g @umbraco/mcp-server
136140

137141
```
138142

139-
For advanced configuration options and environment variable settings, see the Configuration guide.
143+
For advanced configuration options and environment variable settings, see the [Configuration guide](./configuration.md).
140144

141145
## Version Compatibility
142146

16/umbraco-cms/reference/developer-mcp/host-setup/warp.md

Whitespace-only changes.

16/umbraco-cms/reference/developer-mcp/host-setup/windsurf.md

Whitespace-only changes.

0 commit comments

Comments
 (0)