Skip to content

Add Developer MCP documentation #7509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 38 commits into
base: main
Choose a base branch
from
Draft

Add Developer MCP documentation #7509

wants to merge 38 commits into from

Conversation

@hifi-phil
Copy link
Contributor

Set up the initial documentation structure and first page for the Developer Model Context Protocol (MCP) integration in Umbraco CMS v16.

📋 Description

📎 Related Issues (if applicable)

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Deadline (if relevant)

📚 Helpful Resources

@claude
Add initial Developer MCP documentation structure
79571d7 
Set up the initial documentation structure and first page for the Developer Model Context Protocol (MCP) integration in Umbraco CMS v16.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@hifi-phil hifi-phil marked this pull request as draft October 15, 2025 08:35
@hifi-phil hifi-phil changed the title Add Developer MCP documentatio Add Developer MCP documentation Oct 15, 2025
Phil Whittaker and others added 25 commits October 15, 2025 10:35
improve hints
98e604a
@claude
Improve README and remove empty host setup files
69c68b7 
- 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]>
@claude
Add README files for concepts and host-setup sections
8f63245 
Added README files to organize the concepts and host-setup documentation sections.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update SUMMARY.md to reflect new documentation structure
b1424bf 
- Restructured Developer MCP navigation with proper subsections
- Added Key Concepts subsection with Model Context Protocol and Context Engineering
- Added Host Setup subsection with guides for Claude Desktop, Claude Code, Cursor, and GitHub Copilot
- Removed old concepts.md file (replaced with concepts/README.md)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add comprehensive host setup documentation for Claude Desktop and Cla…
6faa086 
…ude 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]>
@claude
Update host setup documentation with improved titles and complete Cur…
8bbc966 
…sor and GitHub Copilot guides

- Update page titles to include "Setup" suffix for consistency
- Add comprehensive Cursor setup guide with configuration and screenshots
- Add GitHub Copilot setup guide with install button and management instructions
- Enhance Claude Desktop documentation with screenshot and improved formatting
- Add cross-references to MCP toolkit selection guide across all host setup pages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Refine host setup documentation with clarity improvements and formatt…
269fde0 
…ing fixes

Updates include:
- Enhanced getting started sections across all host guides
- Improved configuration instructions for Claude Code with emphasis on .mcp.json
- Fixed formatting inconsistencies and hint blocks in Claude Desktop guide
- Clarified tool limit warnings and restart behavior in Cursor guide
- Corrected typos and improved flow in GitHub Copilot guide

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add configuration reminder to GitHub Copilot setup guide
14f76ec 
Added note to remind users to replace placeholder values (UMBRACO_CLIENT_ID, UMBRACO_CLIENT_SECRET, UMBRACO_BASE_URL) with their actual connection details.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add configuration reminder to Claude Code setup guide
71bda78 
Added note to remind users to replace placeholder values with their actual connection details in the CLI configuration section.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add comprehensive configuration documentation for Developer MCP Server
87dd9b8 
Added detailed documentation covering:
- Authentication configuration keys
- Tool and tool collection management options
- Security configuration for media uploads
- Environment configuration methods with precedence order
- Examples for .env file and CLI argument usage

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add NODE_TLS_REJECT_UNAUTHORIZED configuration documentation
ca1180e 
Added documentation for NODE_TLS_REJECT_UNAUTHORIZED setting with warning about local HTTPS connections requiring this to be set to 0.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Improve configuration documentation formatting and clarity
57e8ed8 
Updated formatting in security configuration table and streamlined environment configuration section for better readability.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Rename mcp-toolkit.md to available-tools.md and update references
57d0497 
Renamed mcp-toolkit.md to available-tools.md for clearer documentation structure and updated SUMMARY.md to reflect the new file name.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update SUMMARY.md structure
af57751 
Updated documentation structure in SUMMARY.md.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add Excluded Tools section to SUMMARY.md
c140a0a 
Added new "Excluded Tools" entry in the Developer MCP documentation structure.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Remove duplicate mcp-toolkit.md reference from SUMMARY.md
f0965b4 
Removed the obsolete MCP as a Toolkit entry that was referencing the deleted mcp-toolkit.md file.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add excluded-tools.md documentation file
f8de587 
Added new documentation file for excluded tools in the Developer MCP section.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update context engineering documentation and excluded tools
71c69de 
Updated context engineering documentation with enhanced explanations and added new images (chat-gpt-conversation.png and claude-code-context-window.png). Also updated excluded-tools.md with improved categorization.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update MCP and context engineering documentation, add scenarios page
a898ea5 
- Enhanced Model Context Protocol documentation with reporting examples and LLM collaborator section
- Updated context engineering documentation with improved explanations
- Added new scenarios.md file for use case examples

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add maintenance use case and fix typos in MCP documentation
0daedb2 
Added maintenance use case covering content reorganization, naming standardization, and technical debt cleanup. Fixed typo in schema scaffolding description.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add comprehensive use cases and scenarios documentation for Developer…
d8acd5f 
… MCP

- Create scenarios.md with 23 practical use cases across 8 categories
- Include example prompts and required tool collections for each scenario
- Add table of contents for easy navigation
- Update examples to demonstrate MCP value over standard UI operations
- Add to SUMMARY.md as "Common Use Cases and Scenarios"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update scenarios page title to 'Use Cases and Scenarios'
74b843a 
Simplified title from 'Common Use Cases and Scenarios' for brevity.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Fix table of contents links in scenarios documentation
097369d 
Simplified TOC to link to major H2 section headings instead of individual numbered scenarios for proper anchor link functionality.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Reorganize MCP documentation: consolidate best practices
a24b3a0 
- Replace 'how-best-to-use.md' with 'best-practice.md' for clearer naming
- Remove empty prompt-pack.md file
- Update SUMMARY.md to reflect new documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Add cost and sustainability section to MCP best practices
e676062 
Enhanced the best practices documentation to include considerations about:
- Cost efficiency through context optimization
- Environmental impact of token usage
- Trade-offs between context size, cost, and compute usage

This addition emphasizes that minimizing context isn't just a technical best practice but also reduces monetary costs and carbon footprint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Phil Whittaker and others added 11 commits October 24, 2025 11:32
@claude
Add critical production environment warning section
461a4fd 
Added a prominent 'Never Use Against Production Environments' section in the Host Setup area to strongly warn developers against connecting the MCP Server to production Umbraco instances.

The new section includes:
- Danger-level hint box for maximum visibility
- Clear guidance on appropriate environments (local, staging, test)
- Explicit list of environments to never connect to (production, live sites)
- Reasoning about the risks of LLM-driven actions with direct API access

Also includes minor fixes:
- Fixed broken link to scenarios.md
- Fixed link to available-tools.md (was mcp-toolkit.md)
- Added proper internal links to MCP concepts
- Clarified npx usage description

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update GitHub Copilot install button with tool collections
0d8bdc1 
- Added UMBRACO_INCLUDE_TOOL_COLLECTIONS environment variable with document, media, document-type, and data-type collections
- Removed UMBRACO_EXCLUDE_TOOLS placeholder from the install URL
- Fixed typo: 'restartins' -> 'restarting'

The one-click install button now provides a better default configuration by including the most commonly used tool collections rather than requiring manual exclusion configuration.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update MCP documentation with tool collections and improvements
720cb77 
Major updates across documentation:

**Configuration & Setup:**
- Added UMBRACO_INCLUDE_TOOL_COLLECTIONS with default collections (document, media, document-type, data-type) to all host setup examples
- Updated README with tool collections in sample configuration
- Added tool collections to .env example in configuration.md

**Host Setup Pages:**
- Claude Code: Improved description (CLI vs editor), updated example command with correct collections, enhanced formatting of mcp list hint
- Claude Desktop: Fixed typo 'token and limit' -> 'token limit', fixed link to available-tools.md
- Cursor: Minor wording improvement 'built on' -> 'built as'

**Concept Pages:**
- Context Engineering: Enhanced explanations about LLM control, improved emphasis on key concepts, fixed link to available-tools.md
- Model Context Protocol: Improved wording about API capabilities, added link to scenarios page, added emphasis to 'collaborative development partner'

**Content Fixes:**
- Fixed typo in configuration.md: 'th secure' -> 'the secure'
- Fixed trailing whitespace in scenarios.md
- Updated binary image file (GitHub Coplot.png)

These changes provide better default configurations and clearer guidance for users getting started with the Developer MCP Server.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Comprehensive update to available-tools documentation
999e46b 
Verified and corrected all 37 tool collections against source code in umbraco-mcp repository. This update ensures documentation accurately reflects the actual MCP server implementation.

Major corrections:

**Data Type Collection:**
- Fixed tool name: get-data-type-references -> get-references-data-type
- Added: get-data-type-configuration, get-property-editor-template, find-data-type

**Dictionary Collection:**
- Complete rewrite of tool names to match actual implementation
- Added tree navigation tools: get-dictionary-root, get-dictionary-children, get-dictionary-ancestors
- Added: move-dictionary-item
- Fixed naming convention: all tools now use -item suffix

**Document Collection:**
- Added 6 missing reference tracking tools for better content relationship management
- Added recycle bin reference tools

**Document Blueprint Collection:**
- Added 8 missing tools including scaffold, folder operations, and bulk operations
- Standardized tool naming with document-blueprint prefix

**Document Type Collection:**
- Fixed: get-document-type-by-id-array -> get-document-types-by-id-array

**Media Collection:**
- Added 7 missing tools for reference tracking and bulk operations
- Added: create-media-multiple, get-collection-media

**Media Type Collection:**
- Reorganized tool list for better clarity
- Added: get-media-type-folders
- Fixed tool naming consistency

**Member Collection:**
- Added 5 missing validation and reference tracking tools
- Added: validate-member, validate-member-update, reference tracking tools

**Member Type Collection:**
- Fixed: get-member-type-by-id-array -> get-member-types-by-id-array

**Property Type Collection:**
- Complete rewrite - removed 4 non-existent tools
- Now correctly shows only: get-property-type-is-used

**Server Collection:**
- Complete rewrite of tool names
- Replaced outdated tools with: get-server-configuration, get-server-information, get-server-troubleshooting, get-server-upgrade-check

**Template Collection:**
- Added: get-template-configuration, get-template-search
- Reorganized for better logical flow

All changes verified against source code at /Users/philw/Projects/umbraco-mcp/src/umb-management-api/tools/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update MCP documentation for available tools and Claude Code setup
9d4a078 
- Enhanced available-tools.md with comprehensive tool descriptions
- Updated Claude Code host setup documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update excluded-tools documentation
0125524 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update Developer MCP README documentation
15f8113 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Reorganize Developer MCP best practices documentation
bbecc64 
- Update SUMMARY.md to reflect new best practices structure
- Move best-practice.md content into organized subdirectory
- Improve documentation navigation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update Developer MCP README documentation
bf5d98c 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update Developer MCP README documentation
7d4ec8a 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@claude
Update Developer MCP README documentation
44ca636 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@hifi-phil hifi-phil requested a review from eshanrnh October 25, 2025 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eshanrnh eshanrnh Awaiting requested review from eshanrnh

Assignees

No one assigned

Labels

category/umbraco-cms

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hifi-phil @eshanrnh