Add readme for npm package #451
Conversation
KarishmaGhiya
requested review from
joshfree,
vukelich,
conniey and
xiangyan99
and removed request for
Copilot
KarishmaGhiya
requested review from
JonathanCrd,
sandeep-sen and
JasonYeMSFT
github-project-automation
bot
moved this from Untriaged
to In Progress
in Azure MCP Server
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the Azure MCP NPM package, including a detailed README file and contribution guidelines. The purpose is to provide clear setup instructions, usage examples, and service documentation for users wanting to integrate Azure MCP Server with their projects.
- Added comprehensive README.md with installation instructions, usage examples, and service documentation
- Created CONTRIBUTING.md file with guidelines for contributors
- Added wrapperBinariesArchitecture.md explaining the package architecture
Reviewed Changes
Copilot reviewed 3 out of 11 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| eng/npm/README.md | Comprehensive documentation covering installation, setup, usage examples, and complete list of 26+ supported Azure services |
| eng/npm/CONTRIBUTING.md | Contributor guidelines including submission requirements and legal requirements |
| eng/npm/wrapperBinariesArchitecture.md | Technical documentation explaining the wrapper package architecture for cross-platform support |
|
The broken links will be present once in main. If everything else looks good, can I get an approval? |
KarishmaGhiya
force-pushed
the
npm-sdk
branch
from
50a0f53 to
fde5211
Compare
Co-authored-by: Josh Free <[email protected]>
KarishmaGhiya
force-pushed
the
npm-sdk
branch
from
fde5211 to
1a3fd6d
Compare
|
Can you use azure logo from https://github.com/microsoft/mcp/tree/main/eng/images |
Removed it from my PR, since I wasn't even using it anywhere |
This PR adds a custom readme for Azure MCP Npm package