Skip to content

Update README.md #37

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 2 commits into from
Jul 11, 2025
Merged

Update README.md #37

merged 2 commits into from
Jul 11, 2025

Conversation

JFolberth
Copy link
Contributor

Instruction for MCP w/ GitHub Code Agent. Can't use "." as GitHub MCP tries to read this as a sub property.
This pull request updates the README.md file to include configuration details for GitHub in the Microsoft Learn Docs MCP Server installation guide. The new section provides manual configuration instructions, including a detailed view of the JSON configuration required for GitHub.

Updates to installation guide:

  • README.md: Added a new entry for GitHub in the MCP Server installation guide, including manual configuration details and a collapsible JSON configuration example.

Instruction for MCP w/ GitHub Code Agent. Can't use "." as GitHub MCP tries to read this as a sub property.
@Copilot Copilot AI review requested due to automatic review settings June 27, 2025 14:52
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 updates the README.md installation guide to include a new GitHub configuration section for manual setup with the MCP Server.

  • Adds a new table entry for GitHub with configuration details.
  • Introduces a collapsible JSON configuration example for users to reference.
Comments suppressed due to low confidence (1)

README.md:67

  • The JSON block has inconsistent indentation for the 'tools' key compared to other keys. Consider aligning the indentation for clarity and consistency.
| **GitHub** | Manual configuration required<br/> <details><summary>View Config</summary>**Note**: Navigate to Settings → Coding agent<br/><pre>{<br/>  "docs": {<br/>    "command": "npx",<br/>    "args": [<br/>      "-y",<br/>      "mcp-remote",<br/>      "https://learn.microsoft.com/api/mcp"<br/>    ],<br/> "tools":["*"]<br/>  }<br/>}</pre></details>

@TianqiZhang
Copy link
Collaborator

Thanks for the PR @JFolberth ! Would you mind renaming it from "docs" to "mslearn" just for branding consideration?

@JFolberth
Copy link
Contributor Author

@TianqiZhang, Changes have been submitted

@TianqiZhang TianqiZhang merged commit 23a8585 into MicrosoftDocs:main Jul 11, 2025
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.

2 participants