Clarify that Part 8 Steps 7-11 are educational content, not action items#172
Conversation
Co-authored-by: jongalloway <68539+jongalloway@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Clarifies that Steps 7–11 in Part 8 are informational/educational and not required implementation tasks. Adds introductory blockquoted notes to each step to set reader expectations. Language is now explicit about examples and future best practices.
- Added explanatory "Note" blockquotes to Steps 7–11
- Standardized framing that code shown is illustrative, not required
- No functional code changes introduced; documentation only
|
|
||
| ## Step 7: Security and Validation Considerations | ||
|
|
||
| > **📚 Note**: This step provides **educational content** about security best practices. The code examples below demonstrate concepts you should consider when building production MCP servers. **You don't need to modify the ContosoOrdersMcpServer project** - these are examples to learn from for your own future projects. |
There was a problem hiding this comment.
[nitpick] The wording of the added notes varies across steps (e.g., "You don't need to implement these", "you don't need to add them", "you don't need to add this code", "you don't need to add tests"). Consider standardizing a single closing sentence (e.g., "You don't need to change the sample project; these examples are for your future reference.") and apply it consistently to lines 282, 330, 388, 436, and 466 for improved clarity and uniform reader experience.
Problem
Steps 7-11 in Part 8 of the Enhanced MCP Server workshop were unclear about whether readers should implement the code examples shown. The steps contained advanced code snippets (security validation, caching with
MemoryCache, monitoring withStopwatch, unit testing, etc.) that do not exist in the providedContosoOrdersMcpServerproject, causing confusion about whether:This lack of clarity could lead to:
Solution
Added clear introductory notes to Steps 7, 8, 9, 10, and 11 using a consistent format with 📚 emoji that explicitly states:
Example of changes:
Step 7 now begins with:
This pattern is applied consistently to all five affected steps (7-11), covering:
Impact
Fixes #<issue_number>
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.