Skip to content

Clarify that Part 8 Steps 7-11 are educational content, not action items#172

Merged
jongalloway merged 2 commits intomainfrom
copilot/fix-16ea68e7-f5bb-4098-a41d-4605f9b18deb
Oct 5, 2025
Merged

Clarify that Part 8 Steps 7-11 are educational content, not action items#172
jongalloway merged 2 commits intomainfrom
copilot/fix-16ea68e7-f5bb-4098-a41d-4605f9b18deb

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 5, 2025

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 with Stopwatch, unit testing, etc.) that do not exist in the provided ContosoOrdersMcpServer project, causing confusion about whether:

  • The code was already in the sample and being explained
  • Readers needed to add this code themselves
  • The examples were purely educational

This lack of clarity could lead to:

  • Readers spending time trying to implement unnecessary code
  • Frustration when trying to figure out where to add the examples
  • Breaking the provided working sample

Solution

Added clear introductory notes to Steps 7, 8, 9, 10, and 11 using a consistent format with 📚 emoji that explicitly states:

  • These steps provide educational content and example patterns
  • Readers do NOT need to modify the ContosoOrdersMcpServer project
  • The code examples demonstrate best practices for future production MCP servers
  • They should be used as learning references and inspiration

Example of changes:

Step 7 now begins with:

📚 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.

This pattern is applied consistently to all five affected steps (7-11), covering:

  • Security and validation considerations
  • Advanced business scenarios (multi-system integration)
  • Performance and scalability (caching, async operations)
  • Monitoring and observability (logging)
  • Testing business logic (unit tests)

Impact

  • ✅ Clear separation between hands-on steps (1-6) and educational content (7-11)
  • ✅ Readers understand they can proceed to Part 9 after Step 6 if desired
  • ✅ Advanced concepts remain documented for reference
  • ✅ No code changes - documentation only
  • ✅ Builds successfully with expected warnings

Fixes #<issue_number>

Original prompt

This section details on the original issue you should resolve

<issue_title>Clarify steps 7-10 of Part 8</issue_title>
<issue_description>Steps 7-10 aren't clear. Are they explaining code that's in the provided sample? Is the reader supposed to do something? Please give clear guidance to the reader.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #171

💡 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.

Co-authored-by: jongalloway <68539+jongalloway@users.noreply.github.com>
@jongalloway jongalloway requested a review from Copilot October 5, 2025 02:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link

Copilot AI Oct 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Copilot uses AI. Check for mistakes.
Copilot AI changed the title [WIP] Clarify steps 7-10 of Part 8 Clarify that Part 8 Steps 7-11 are educational content, not action items Oct 5, 2025
Copilot AI requested a review from jongalloway October 5, 2025 02:41
@jongalloway jongalloway marked this pull request as ready for review October 5, 2025 03:12
@jongalloway jongalloway merged commit 12fcdf8 into main Oct 5, 2025
9 of 11 checks passed
@jongalloway jongalloway deleted the copilot/fix-16ea68e7-f5bb-4098-a41d-4605f9b18deb branch October 5, 2025 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify steps 7-10 of Part 8

3 participants