Skip to content

Adding case studies on learn mcp #160

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.

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

Merged
merged 9 commits into from
Jun 21, 2025
Merged

Conversation

ShivamGoyal03
Copy link
Contributor

This pull request introduces a new case study focused on integrating the Microsoft Learn Docs MCP server with a Python client. It includes comprehensive documentation, a practical assignment, and a fully implemented Python client to demonstrate real-time, context-aware documentation retrieval. The changes aim to improve developer workflows by reducing context switching and enabling seamless access to up-to-date documentation.

New Case Study: Real-Time Documentation Retrieval

Documentation and Learning Material:

  • Added a new case study, "Real-Time Documentation Retrieval with MCP," in 09-CaseStudy/MCPforDocumentation.md. This document provides an overview, learning objectives, an assignment, sample queries, a solution, and additional resources for connecting a Python client to the Microsoft Learn Docs MCP server.
  • Updated 09-CaseStudy/README.md to include the new case study in the list of examples, highlighting its practical applications and key takeaways.

Implementation:

  • Created a detailed README.md file in 09-CaseStudy/scenario3/ with installation steps, usage instructions, and sample queries for the Python client.
  • Added client.py, a Python script that connects to the Microsoft Learn Docs MCP server, executes documentation queries using the microsoft_docs_search tool, and logs the streaming results. The client features interactive input, logging, and error handling.

Supporting Updates:

  • Updated the list of references in 09-CaseStudy/README.md to include a link to the Microsoft Docs MCP Server GitHub repository.

@Copilot Copilot AI review requested due to automatic review settings June 20, 2025 12:27
Copy link
Contributor

@Copilot 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

This PR adds a new case study for real-time documentation retrieval using the Microsoft Learn Docs MCP server and a Python client.

  • Introduces client.py, an interactive Python console client leveraging MCP for streaming documentation queries.
  • Adds detailed scenario README and a standalone case study markdown (MCPforDocumentation.md).
  • Updates the main case studies README to include the new entry and references.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
09-CaseStudy/scenario3/client.py Interactive Python MCP client implementation
09-CaseStudy/scenario3/README.md Instructions, prerequisites, and usage guide for scenario 3
09-CaseStudy/README.md Added “Real-Time Documentation Retrieval with MCP” entry
09-CaseStudy/MCPforDocumentation.md New detailed case study walkthrough and assignment
Comments suppressed due to low confidence (4)

09-CaseStudy/scenario3/README.md:1

  • [nitpick] The heading refers to 'Scenario 1' but this lives in the scenario3 folder; update it to 'Scenario 3' for consistency.
# Scenario 1: Python Console Client for Microsoft Learn Docs MCP Server

09-CaseStudy/scenario3/client.py:1

  • [nitpick] Convert the commented block at the top into a proper module-level docstring (triple-quoted) so IDEs and documentation tools can parse it correctly.
# """

09-CaseStudy/scenario3/client.py:69

  • [nitpick] Rename 'my_list' to something more descriptive (e.g., 'docs_list') to improve readability and maintainability.
                                my_list = json.loads(item.text)

09-CaseStudy/scenario3/client.py:39

  • [nitpick] Consider adding unit or integration tests for 'main' and its error paths (e.g., connection failures, JSON parsing) to ensure the client behaves as expected under various conditions.
async def main():

@ShivamGoyal03 ShivamGoyal03 changed the title WIP: Adding case studies on learn mcp Adding case studies on learn mcp Jun 20, 2025
@leestott leestott merged commit fc4002e into microsoft:main Jun 21, 2025
1 check passed
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.

3 participants