Skip to content

Commit 6faa086

Browse files
Phil Whittakerclaude
andcommitted
Add comprehensive host setup documentation for Claude Desktop and Claude Code
- Added detailed setup guide for Claude Desktop with configuration examples - Added detailed setup guide for Claude Code with CLI and .mcp.json configuration - Updated main README with Node.js version requirement hint - Improved formatting of host setup links in README 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent b1424bf commit 6faa086

File tree

3 files changed

+145
-5
lines changed

3 files changed

+145
-5
lines changed

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

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,18 @@ For example:
8181
- 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" %}
84-
Only use a dedicated API user for MCP connections. Do not share or reuse credentials from an existing backoffice user.
84+
Only use a dedicated API user for MCP connections.
85+
Do not share or reuse credentials from an existing backoffice user.
8586
{% endhint %}
8687

8788
### Host Setup
8889

8990
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:
9091

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)
92+
[Claude Desktop](./host-setup/claude-desktop.md)
93+
[Claude Code](./host-setup/claude-code.md)
94+
[GitHub Copilot](./host-setup/github-copilot.md)
95+
[Cursor](./host-setup/cursor.md)
9596

9697
Although the details vary slightly, the general pattern is the same across all hosts:
9798

@@ -115,6 +116,11 @@ Add your Umbraco MCP configuration values (Client ID, Client Secret, URL of umbr
115116

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

119+
{% hint style="info" %}
120+
This Developer MCP Server requires Node.js version 22 or higher to be installed.
121+
You can check your current Node.js version by running node -v in your terminal.
122+
{% endhint %}
123+
118124
### Choosing Your Tools
119125

120126
Your first step after setup should be deciding which tools you want to enable.
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
description: "Host set up for Claude Code"
3+
---
4+
5+
# Claude Code
6+
7+
[Claude Code](https://www.claude.com/product/claude-code) is a developer-focused coding environment from Anthropic that integrates Claude’s large language models (LLMs) directly into your code editor.
8+
It allows you to chat, refactor, and generate code within your projects.
9+
10+
To get started install Claude Code globally
11+
12+
```bash
13+
npm install -g @anthropic-ai/claude-code
14+
```
15+
16+
## Configuration using the CLI tool
17+
18+
Basic install
19+
20+
```bash
21+
claude mcp add umbraco-mcp npx @umbraco-cms/mcp-dev@beta
22+
```
23+
24+
If you prefer to define configuration values directly, use the following pattern:
25+
26+
```bash
27+
28+
# Add with environment variables
29+
claude mcp add umbraco-mcp --env UMBRACO_CLIENT_ID="your-id" --env UMBRACO_CLIENT_SECRET="your-secret" --env UMBRACO_BASE_URL="https://your-domain.com" --env NODE_TLS_REJECT_UNAUTHORIZED="0" --env UMBRACO_INCLUDE_TOOL_COLLECTIONS="culture,document,media" -- npx @umbraco-cms/mcp-dev@beta
30+
```
31+
32+
This will register umbraco-mcp in your project’s claude.json configuration file.
33+
34+
{% hint style="info" %}
35+
Use claude mcp list anytime to confirm which MCP servers are active in your Claude Code environment.
36+
{% endhint %}
37+
38+
## Configuration via .mcp.json (Project-specific)
39+
40+
For project-level configuration, create a .mcp.json file in your project root.
41+
42+
Using the `.mcp.json` file allows you to:
43+
- Configure MCP servers per project
44+
- Share configuration safely with team members
45+
- Override global Claude Code MCP settings
46+
- Use an .env file to prevent secrets being added to source
47+
48+
Example .env file
49+
50+
```bash
51+
UMBRACO_CLIENT_ID=umbraco-back-office-mcp
52+
UMBRACO_CLIENT_SECRET=1234567890
53+
UMBRACO_BASE_URL=http://localhost:123456
54+
```
55+
56+
Example .mcp.json file
57+
58+
```json
59+
{
60+
"mcpServers": {
61+
"umbraco-mcp": {
62+
"command": "npx",
63+
"args": ["@umbraco-cms/mcp-dev@beta"],
64+
}
65+
}
66+
}
67+
```
68+
69+
For details on .env format and supported configuration keys, see the [Configuration guide](../configuration.md).
70+
71+
{% hint style="warning" %}
72+
Never commit live credentials to source control. Always use environment variables or a .env file.
73+
{% endhint %}
74+
75+
## Easier tool and tool collection management
76+
77+
Another benefit of using a .env file is that it makes it much easier to adjust tool configurations for different tasks.
78+
Claude Code lets you quickly reconnect to an MCP server using its slash commands, so you can switch environments or update settings without editing your main configuration files.
79+
80+
- Update the .env file with the new tools set
81+
- In Claude Code CLI use **/mcp reconnect umbraco-mcp** to restart the mcp server
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
description: "Host set up for Claude Desktop"
3+
---
4+
5+
# Claude Desktop
6+
7+
[Claude Desktop](https://www.anthropic.com/claude/desktop) is Anthropic’s AI-powered assistant for macOS and Windows, designed to help you work conversationally across all kinds of tasks — from writing and brainstorming to coding and automation.
8+
9+
## Getting started
10+
11+
First download and install the [Claude.ai desktop app](https://claude.ai/download).
12+
13+
To edit the MCP settings, go to Settings → Developer → Edit Config.
14+
Open the JSON configuration file in your preferred text editor and add the following snippet. Replace the UMBRACO_CLIENT_ID, UMBRACO_CLIENT_SECRET, and UMBRACO_BASE_URL values with your local connection details.
15+
16+
The NODE_TLS_REJECT_UNAUTHORIZED environment flag is included to allow Claude Desktop to connect to the MCP Server when using a self-signed certificate.
17+
18+
19+
```bash
20+
{
21+
"mcpServers":
22+
{
23+
"umbraco-mcp":
24+
{
25+
"command": "npx",
26+
"args": ["@umbraco-cms/mcp-dev@beta"],
27+
"env":
28+
{
29+
"NODE_TLS_REJECT_UNAUTHORIZED": "0",
30+
"UMBRACO_CLIENT_ID": "umbraco-back-office-mcp",
31+
"UMBRACO_CLIENT_SECRET": "1234567890",
32+
"UMBRACO_BASE_URL": "https://localhost:12345"
33+
}
34+
}
35+
}
36+
}
37+
```
38+
39+
Restart Claude to activate the new configuration.
40+
When the Umbraco MCP Server starts, you’ll be prompted to allow access for each of the available tools.
41+
42+
If you encounter a connection error, open the logs and review the file named mcp-server-umbraco-mcp.log for details on how to resolve the issue.
43+
44+
> [!NOTE]
45+
> You may need to update to a paid version of Claude.ai in order to have a large enough context window to run your prompts.
46+
47+
## Node version mismatch
48+
49+
Occasionally, Claude Desktop may use the wrong version of Node.js when running the MCP Server.
50+
A minimum of Node.js version 22 is required. This issue most commonly occurs when using a Node.js version manager such as nvm, as Claude Desktop can sometimes default to the lowest installed version rather than the active one set by nvm.
51+
52+
Unfortunately, the only reliable fix is to remove all older Node.js versions, leaving only version 22 or higher installed.
53+
This behaviour appears to be specific to Claude Desktop and does not affect other AI hosts.

0 commit comments

Comments
 (0)