Skip to content

Commit 56f6ffc

Browse files
Phil Whittakerclaude
andcommitted
Standardize environment variable naming and update documentation
- Update environment variable names to consistent UMBRACO_* pattern: - INCLUDE_MANAGEMENT_TOOLS → UMBRACO_INCLUDE_TOOLS - EXCLUDE_MANAGEMENT_TOOLS → UMBRACO_EXCLUDE_TOOLS - INCLUDE_MANAGEMENT_COLLECTIONS → UMBRACO_INCLUDE_TOOL_COLLECTIONS - EXCLUDE_MANAGEMENT_COLLECTIONS → UMBRACO_EXCLUDE_TOOL_COLLECTIONS - Update all configuration files, tests, and documentation - Fix TypeScript compilation issue in property-type-test-helper.ts - Create comprehensive tool collection filtering documentation - Remove outdated OpenAPI group filtering plan document 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 07ebd70 commit 56f6ffc

File tree

15 files changed

+319
-686
lines changed

15 files changed

+319
-686
lines changed

OPENAPI_GROUP_FILTERING_PLAN.md

Lines changed: 0 additions & 628 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Once you have this information head back into Claude desktop app and head to Set
4040
"UMBRACO_CLIENT_ID": "umbraco-back-office-mcp",
4141
"UMBRACO_CLIENT_SECRET": "1234567890",
4242
"UMBRACO_BASE_URL": "https://localhost:44391",
43-
"INCLUDE_MANAGEMENT_COLLECTIONS": "culture,document,media",
44-
"EXCLUDE_MANAGEMENT_TOOLS": "delete-document,empty-recycle-bin"
43+
"UMBRACO_INCLUDE_TOOL_COLLECTIONS": "culture,document,media",
44+
"UMBRACO_EXCLUDE_TOOLS": "delete-document,empty-recycle-bin"
4545
}
4646
}
4747
}
@@ -71,7 +71,7 @@ Or configure environment variables and scope:
7171
npm install -g @anthropic-ai/claude-code
7272

7373
# Add with environment variables
74-
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 INCLUDE_MANAGEMENT_COLLECTIONS="culture,document,media" -- npx @umbraco-mcp/umbraco-mcp-cms@alpha
74+
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-mcp/umbraco-mcp-cms@alpha
7575

7676
# Verify installation
7777
claude mcp list
@@ -86,7 +86,7 @@ This will add umbraco-mcp to the existing project in the claude.json config file
8686
<summary>VS Code</summary>
8787

8888
#### Click the button to install:
89-
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522umbraco-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540umbraco-mcp%252Fumbraco-mcp-cms%2540alpha%2522%255D%252C%2522env%2522%253A%257B%2522UMBRACO_CLIENT_ID%2522%253A%2522%253CAPI%2520user%2520name%253E%2522%252C%2522UMBRACO_CLIENT_SECRET%2522%253A%2522%253CAPI%2520client%2520secert%253E%2522%252C%2522UMBRACO_BASE_URL%2522%253A%2522https%253A%252F%252F%253Cdomain%253E%2522%252C%2522EXCLUDE_MANAGEMENT_TOOLS%2522%253A%2522%253Ctoolname%253E%252C%253Ctoolname%253E%2522%257D%257D)
89+
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522umbraco-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522%2540umbraco-mcp%252Fumbraco-mcp-cms%2540alpha%2522%255D%252C%2522env%2522%253A%257B%2522UMBRACO_CLIENT_ID%2522%253A%2522%253CAPI%2520user%2520name%253E%2522%252C%2522UMBRACO_CLIENT_SECRET%2522%253A%2522%253CAPI%2520client%2520secert%253E%2522%252C%2522UMBRACO_BASE_URL%2522%253A%2522https%253A%252F%252F%253Cdomain%253E%2522%252C%2522UMBRACO_EXCLUDE_TOOLS%2522%253A%2522%253Ctoolname%253E%252C%253Ctoolname%253E%2522%257D%257D)
9090

9191
**Requirements:** VS Code 1.101+ with GitHub Copilot Chat extension installed.
9292

@@ -104,8 +104,8 @@ Follow the MCP [install guide](https://code.visualstudio.com/docs/copilot/custom
104104
"UMBRACO_CLIENT_ID": "<API user name>",
105105
"UMBRACO_CLIENT_SECRET": "<API client secret>",
106106
"UMBRACO_BASE_URL": "https://<domain>",
107-
"INCLUDE_MANAGEMENT_COLLECTIONS": "<collection>,<collection>",
108-
"EXCLUDE_MANAGEMENT_TOOLS": "<toolname>,<toolname>"
107+
"UMBRACO_INCLUDE_TOOL_COLLECTIONS": "<collection>,<collection>",
108+
"UMBRACO_EXCLUDE_TOOLS": "<toolname>,<toolname>"
109109
}
110110
}
111111
}
@@ -132,8 +132,8 @@ Add the following to the config file and update the env variables.
132132
"UMBRACO_CLIENT_ID": "<API user name>",
133133
"UMBRACO_CLIENT_SECRET": "<API client secret>",
134134
"UMBRACO_BASE_URL": "https://<domain>",
135-
"INCLUDE_MANAGEMENT_COLLECTIONS": "<collection>,<collection>",
136-
"EXCLUDE_MANAGEMENT_TOOLS": "<toolname>,<toolname>"
135+
"UMBRACO_INCLUDE_TOOL_COLLECTIONS": "<collection>,<collection>",
136+
"UMBRACO_EXCLUDE_TOOLS": "<toolname>,<toolname>"
137137
}
138138
}
139139
}
@@ -156,26 +156,26 @@ Umbraco API User client secert
156156

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

159-
`EXCLUDE_MANAGEMENT_TOOLS`
159+
`UMBRACO_EXCLUDE_TOOLS`
160160

161161
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.
162162

163-
`INCLUDE_MANAGEMENT_TOOLS`
163+
`UMBRACO_INCLUDE_TOOLS`
164164

165165
The allows you to specify tools by name if you wish to include only specific tools in the usable tools list. When specified, only these tools will be available. This is a commma seperated list of tools which can be found below.
166166

167-
`INCLUDE_MANAGEMENT_COLLECTIONS`
167+
`UMBRACO_INCLUDE_TOOL_COLLECTIONS`
168168

169169
The allows you to specify collections by name if you wish to include only specific collections. When specified, only tools from these collections will be available. This is a commma seperated list of collection names (see tool list below for collection names).
170170

171-
`EXCLUDE_MANAGEMENT_COLLECTIONS`
171+
`UMBRACO_EXCLUDE_TOOL_COLLECTIONS`
172172

173173
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).
174174

175175

176176
## Umbraco Management API Tools
177177

178-
**Note:** Collection names are shown in brackets for use with `INCLUDE_MANAGEMENT_COLLECTIONS` and `EXCLUDE_MANAGEMENT_COLLECTIONS`.
178+
**Note:** Collection names are shown in brackets for use with `UMBRACO_INCLUDE_TOOL_COLLECTIONS` and `UMBRACO_EXCLUDE_TOOL_COLLECTIONS`.
179179

180180
<details>
181181
<summary> View Tool list</summary>

docs/analysis/UNSUPPORTED_ENDPOINTS.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@ This document provides a comprehensive comparison between the available Umbraco
55
## Summary
66

77
- **Total API Endpoints**: 393
8-
- **Implemented Tools**: 187
9-
- **Coverage**: ~47.6%
10-
- **Missing Endpoints**: ~206
8+
- **Implemented Tools**: 269
9+
- **Coverage**: ~68.4%
10+
- **Missing Endpoints**: ~124
11+
12+
**Recent Updates:**
13+
- Added Document Version tools (4 endpoints)
14+
- Added Stylesheet tools (11 endpoints)
15+
- Added Script tools (10 endpoints)
16+
- Expanded Partial View coverage
17+
- Enhanced test infrastructure and collection filtering system
1118

1219
## Coverage by Section
1320

@@ -17,6 +24,7 @@ This document provides a comprehensive comparison between the available Umbraco
1724
- **Dictionary**: ~90% coverage (9/10 endpoints)
1825
- **Document Blueprints**: ~85% coverage (6/7 endpoints)
1926
- **Document Types**: ~88% coverage (22/25 endpoints)
27+
- **Document Versions**: 100% coverage (4/4 endpoints) *NEW*
2028
- **Documents**: ~79% coverage (38/48 endpoints)
2129
- **Languages**: ~85% coverage (6/7 endpoints)
2230
- **Log Viewer**: ~90% coverage (9/10 endpoints)
@@ -25,9 +33,12 @@ This document provides a comprehensive comparison between the available Umbraco
2533
- **Member Groups**: ~85% coverage (6/7 endpoints)
2634
- **Member Types**: ~80% coverage (8/10 endpoints)
2735
- **Members**: ~83% coverage (5/6 endpoints)
36+
- **Partial Views**: ~83% coverage (10/12 endpoints) *IMPROVED*
2837
- **Property Types**: 100% coverage (1/1 endpoints)
2938
- **Redirects**: 100% coverage (5/5 endpoints)
39+
- **Scripts**: 100% coverage (10/10 endpoints) *NEW*
3040
- **Server**: 100% coverage (5/5 endpoints)
41+
- **Stylesheets**: 100% coverage (11/11 endpoints) *NEW*
3142
- **Templates**: 100% coverage (10/10 endpoints)
3243
- **Temporary Files**: 100% coverage (4/4 endpoints)
3344
- **User Groups**: 100% coverage (8/8 endpoints)
@@ -291,11 +302,11 @@ This document provides a comprehensive comparison between the available Umbraco
291302
1. **User Management** - Critical for user administration
292303
2. **Authentication & Security** - Essential for security operations
293304
3. **Package Management** - Important for deployment and maintenance
294-
4. **Version Management** - Important for content workflows
305+
4. ~~**Version Management**~~ - ✅ COMPLETED (Document Versions added)
295306

296307
### Medium Priority (Development tools)
297-
1. **Scripting & Views** - Important for developers
298-
2. **Stylesheets** - Important for theming
308+
1. ~~**Scripting & Views**~~ - ✅ COMPLETED (Scripts and Partial Views added)
309+
2. ~~**Stylesheets**~~ - ✅ COMPLETED (100% coverage achieved)
299310
3. **System Operations** - Important for maintenance
300311

301312
### Low Priority (Specialized features)
@@ -305,11 +316,21 @@ This document provides a comprehensive comparison between the available Umbraco
305316

306317
## Implementation Notes
307318

308-
Most missing endpoints fall into these categories:
309-
- Advanced administrative functions
310-
- Developer-focused tools
311-
- System maintenance operations
319+
**Recent Achievements (68.4% coverage):**
320+
-**Document Versions** - Complete rollback and cleanup functionality
321+
-**Stylesheets** - Full CRUD operations and tree navigation
322+
-**Scripts** - Complete script file management
323+
-**Enhanced Test Infrastructure** - Comprehensive testing patterns and collection filtering
324+
-**Improved Coverage** - Significant jump from 47.6% to 68.4%
325+
326+
**Remaining gaps focus on:**
327+
- Advanced administrative functions (User management, Security)
328+
- System maintenance operations (Packages, Health checks)
312329
- Import/export functionality
313-
- Advanced content workflows
330+
- Specialized features (Relations, Tags, Static files)
314331

315-
The current MCP implementation covers the core content management workflows very well, with strong coverage of the primary content, media, and type management operations that most users need day-to-day.
332+
The current MCP implementation now provides excellent coverage of the core content management workflows, with strong support for:
333+
- All content types (Documents, Media, Members)
334+
- Development workflow (Scripts, Stylesheets, Templates, Partial Views)
335+
- Content versioning and rollback capabilities
336+
- Comprehensive testing and quality assurance

docs/analysis/api-endpoints-analysis.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,15 +504,24 @@
504504
## Summary Statistics
505505

506506
**Total Endpoints:** 393
507+
**MCP Tools Implemented:** 269
508+
**Coverage:** 68.4%
507509

508510
**Categories:** 37
509511

510512
**Major Functional Areas:**
511-
- **Content Management:** Documents (48 endpoints), Media (34 endpoints), Templates (10 endpoints)
513+
- **Content Management:** Documents (48 endpoints), Document Versions (4 endpoints), Media (34 endpoints), Templates (10 endpoints)
512514
- **Content Types:** Document Types (25 endpoints), Media Types (25 endpoints), Data Types (20 endpoints)
513515
- **User Management:** Users (36 endpoints), User Groups (8 endpoints), Members (10 endpoints)
514-
- **Development:** Scripts (10 endpoints), Stylesheets (10 endpoints), Partial Views (12 endpoints)
516+
- **Development:** Scripts (10 endpoints), Stylesheets (11 endpoints), Partial Views (12 endpoints)
515517
- **System Management:** Server (5 endpoints), Security (4 endpoints), Health Check (4 endpoints)
516518
- **Configuration:** Various configuration endpoints across categories
517519
- **Tree Operations:** Tree navigation endpoints for hierarchical content
518-
- **Search & Filtering:** Search and filter endpoints across content types
520+
- **Search & Filtering:** Search and filter endpoints across content types
521+
522+
**Recent Additions:**
523+
- Document Version management (rollback, cleanup)
524+
- Complete Stylesheet file management
525+
- Full Script file operations
526+
- Enhanced collection filtering system
527+
- Comprehensive testing infrastructure

0 commit comments

Comments
 (0)