Skip to content

Commit 76ef48b

Browse files
Phil Whittakerclaude
andcommitted
Update README and ignored endpoints documentation
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 73905e3 commit 76ef48b

File tree

2 files changed

+41
-19
lines changed

2 files changed

+41
-19
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Umbraco MCP ![GitHub License](https://img.shields.io/github/license/umbraco/Umbraco-CMS-MCP-Dev?style=plastic&link=https%3A%2F%2Fgithub.com%2Fumbraco%2FUmbraco-CMS-MCP-Dev%2Fblob%2Fmain%2FLICENSE)
22

33
An MCP (Model Context Protocol) server for [Umbraco CMS](https://umbraco.com/)
4-
it provides access to key parts of the Management API enabling you to do back office tasks with your agent.
4+
it provides developer access to the majority of the Management API enabling you to complete most back office tasks with your agent that you can accomplish using the UI.
55

66
## Intro
77

@@ -29,6 +29,7 @@ Start up your Umbraco instance (currently working with version **15.latest**) an
2929

3030
Once you have this information head back into Claude desktop app and head to Settings > Developer > Edit Config. Open the json file in a text editor of your choice and add the below, replacing the `UMBRACO_CLIENT_ID`, `UMBRACO_CLIENT_SECRET` and `UMBRACO_BASE_URL` with your local connection information. The addition of the `NODE_TLS_REJECT_UNAUTHORIZED` env flag is to allow Claude to connect to the MCP using a self-signed cert.
3131

32+
3233
```
3334
{
3435
"mcpServers": {
@@ -141,21 +142,53 @@ Add the following to the config file and update the env variables.
141142
```
142143
</details>
143144

144-
145-
### Configuration Environment Variables
145+
### Authentication Configuration Keys
146146

147147
`UMBRACO_CLIENT_ID`
148148

149149
Umbraco API User name
150150

151-
`UMBRACO_CLIENT_SECRET`
152-
151+
`UMBRACO_CLIENT_SECRET`
153152
Umbraco API User client secert
154153

155154
`UMBRACO_BASE_URL`
156155

157156
Url of the site you want to connect to, it only needs to be the scheme and domain e.g https://<nolink/>example.com
158157

158+
## API Coverage
159+
160+
This MCP server provides **comprehensive coverage** of the Umbraco Management API. We have achieved **full parity** with all applicable endpoints, implementing tools for every operational endpoint suitable for AI-assisted content management.
161+
162+
### Implementation Status
163+
164+
**✅ Implemented:** All 36 tool collections covering operational endpoints
165+
- Content management (Documents, Media, Members)
166+
- Configuration (Document Types, Media Types, Data Types)
167+
- System management (Templates, Scripts, Stylesheets)
168+
- User administration (Users, User Groups, Permissions)
169+
- Advanced features (Webhooks, Relations, Health Checks)
170+
171+
**⚠️ Intentionally Excluded:** 69 endpoints across 14 categories
172+
173+
Certain endpoints are intentionally not implemented due to security, complexity, or contextual concerns. For a detailed breakdown of excluded endpoints and the rationale behind each exclusion, see [Ignored Endpoints Documentation](./docs/analysis/IGNORED_ENDPOINTS.md).
174+
175+
### Excluded Categories Summary
176+
177+
- **User Management (22 endpoints)** - User creation/deletion, password operations, 2FA management, and client credentials pose significant security risks
178+
- **User Group Membership (3 endpoints)** - Permission escalation risks from AI-driven group membership changes
179+
- **Security Operations (4 endpoints)** - Password reset workflows require email verification and user interaction
180+
- **Import/Export (9 endpoints)** - Complex file operations better handled through the Umbraco UI
181+
- **Package Management (9 endpoints)** - Package creation and migration involve system-wide changes
182+
- **Cache Operations (3 endpoints)** - Cache rebuild can impact system performance
183+
- **Telemetry (3 endpoints)** - System telemetry configuration and data collection
184+
- **Install/Upgrade (5 endpoints)** - One-time system setup and upgrade operations
185+
- **Preview/Profiling (4 endpoints)** - Frontend-specific debugging functionality
186+
- **Other (7 endpoints)** - Internal system functionality, oEmbed, dynamic roots, object types
187+
188+
For a comprehensive source code analysis validating these exclusions, see [Endpoint Exclusion Review](./docs/analysis/ENDPOINT_EXCLUSION_REVIEW.md).
189+
190+
### Configuration Environment Variables
191+
159192
`UMBRACO_EXCLUDE_TOOLS`
160193

161194
The allows you to specify tools by name if you wish to exclude them for the usable tools list. This is helpful as some Agents, cant handle so many tools. This is a commma seperated list of tools which can be found below.
@@ -173,7 +206,7 @@ The allows you to specify collections by name if you wish to include only specif
173206
The allows you to specify collections by name if you wish to exclude them from the usable tools list. This is a commma seperated list of collection names (see tool list below for collection names).
174207

175208

176-
## Umbraco Management API Tools
209+
### Tool Collections
177210

178211
**Note:** Collection names are shown in brackets for use with `UMBRACO_INCLUDE_TOOL_COLLECTIONS` and `UMBRACO_EXCLUDE_TOOL_COLLECTIONS`.
179212

docs/analysis/IGNORED_ENDPOINTS.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,6 @@ Security endpoints are excluded because:
139139

140140
Telemetry endpoints are excluded because:
141141
1. System telemetry data may contain sensitive system information
142-
2. Telemetry configuration changes could affect system monitoring and analytics
143-
3. Data collection settings raise privacy concerns and should be managed through the UI
144-
4. Automated modification of telemetry settings could impact system diagnostics
145142

146143
User Group membership endpoints are excluded because:
147144
1. These operations present severe permission escalation risks
@@ -153,7 +150,6 @@ PublishedCache endpoints are excluded because:
153150
1. Cache rebuild operations can significantly impact system performance and should be carefully timed
154151
2. Cache operations can affect site availability and user experience during execution
155152
3. Cache rebuild status monitoring could expose sensitive system performance information
156-
4. These operations require careful consideration of timing and system load and should be managed through the Umbraco UI
157153

158154
Upgrade endpoints are excluded because:
159155
1. System upgrade operations involve critical system modifications that could break the installation
@@ -182,22 +178,15 @@ Preview endpoints are excluded because:
182178
1. Content preview functionality is designed for frontend website display and user interface interactions
183179
2. Preview operations are primarily used for content editors to see how content will appear on the website
184180
3. These operations are frontend-specific and not relevant for automated data management through MCP
185-
4. Preview creation and deletion are temporary UI-focused operations that have no use case in the MCP context
186181

187182
Oembed endpoints are excluded because:
188-
1. oEmbed functionality is used for embedding external media content (videos, social media posts) into web pages
183+
1. oEmbed functionality is used for embedding external media content (videos, social media posts) into rich text editor
189184
2. This is primarily a frontend feature for content display and presentation
190-
3. oEmbed queries are typically used by content editors when creating web content, not for automated data management
191-
4. This frontend-specific functionality has no relevant use case in the MCP context
192185

193186
Object endpoints are excluded because:
194187
1. Object type enumeration provides internal system metadata about Umbraco's object structure
195188
2. This information is primarily used by the Umbraco backend for internal operations and UI generation
196-
3. Object type data would be confusing and not actionable for AI assistants working with content
197-
4. This internal system functionality has no practical use case for MCP operations
198189

199190
Dynamic endpoints are excluded because:
200191
1. Dynamic root functionality is an advanced configuration feature for creating custom content tree structures
201-
2. These operations involve complex system configuration that requires deep understanding of Umbraco architecture
202-
3. Dynamic root configuration is typically performed by experienced developers during system setup
203-
4. This advanced configuration functionality is not suitable for automated AI operations and could cause system instability if misused
192+
2. These operations are better compled using the UI

0 commit comments

Comments
 (0)