Skip to content

Commit b00c2c4

Browse files
TianqiZhangclaude
andauthored
Streamline README: trim redundant sections and improve CLI presentation (#130)
- Simplify Example Prompts to 4 clean examples without instructional text - Remove Key Capabilities section (duplicates tools table) - Remove Getting Started steps (redundant with install table) - Remove Future Enhancements section (vague, no user value) - Add preview label and npm badge to CLI section - Fix code block language markers (bash -> sh, remove bash from plugin commands) - Clarify --json flag description Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent abe8ea1 commit b00c2c4

1 file changed

Lines changed: 14 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,15 @@ Stop relying on outdated training data or risky web searches. Learn MCP server p
2121

2222
* 💸 **Completely Free.** High search capacity tailored for seamless, heavy coding sessions.
2323

24-
### ✨ Example Prompts: Your Source of Truth
24+
### ✨ Example Prompts
2525

26-
Your AI assistant should automatically use these tools for Microsoft-related topics. With both search and fetch capabilities, you can get quick answers or comprehensive deep dives. To ensure that it always consults the official documentation, you can add phrases like `search Microsoft Learn`, `deep dive`, `fetch full doc`.
26+
> "Give me the Azure CLI commands to create an Azure Container App with a managed identity."
2727
28-
#### **Quick Search & Reference**
28+
> "Is gpt-5.4 available in Azure EU regions?"
2929
30-
> "Give me the Azure CLI commands to create an Azure Container App with a managed identity. **search Microsoft Learn**"
30+
> "Are you sure this is the right way to implement `IHttpClientFactory` in a .NET 8 minimal API?"
3131
32-
> "Is gpt-4.1-mini available in EU regions? **fetch full doc**"
33-
34-
#### **Code Verification & Best Practices**
35-
36-
> "Are you sure this is the right way to implement `IHttpClientFactory` in a .NET 8 minimal API? **search Microsoft Learn and fetch full doc**"
37-
38-
> "Show me the complete guide for implementing authentication in ASP.NET Core. **fetch full doc**"
39-
40-
> "show me detailed, runnable python code sample to do harms eval using azure ai foundry evaluation sdk"
41-
42-
#### **Comprehensive Learning & Deep Dive**
43-
44-
> "I need to understand Azure Functions end-to-end. **search Microsoft Learn and deep dive**"
45-
46-
> "Get me the full step-by-step tutorial for deploying a .NET application to Azure App Service. **search Microsoft Learn and deep dive**"
47-
48-
### 📊 Key Capabilities
49-
50-
- **High-Quality Content Retrieval**: Search and retrieve relevant content from Microsoft's official documentation in markdown format.
51-
- **Code Sample Discovery**: Find official Microsoft/Azure code snippets and examples with language-specific filtering.
52-
- **Semantic Understanding**: Uses advanced vector search to find the most contextually relevant documentation for any query.
53-
- **Real-time Updates**: Access the latest Microsoft documentation as it's published.
32+
> "Show me runnable Python code to do harms eval using the Azure AI Foundry evaluation SDK."
5433
5534
## 🌐 The Microsoft Learn MCP Server Endpoint
5635

@@ -107,24 +86,25 @@ https://learn.microsoft.com/api/mcp?maxTokenBudget=2000
10786
| `microsoft_docs_fetch` | Fetch and convert a Microsoft documentation page into markdown format | `url` (string): URL of the documentation page to read |
10887
| `microsoft_code_sample_search` | Search for official Microsoft/Azure code snippets and examples | `query` (string): Search query for Microsoft/Azure code snippets<br/>`language` (string, optional): Programming language filter.|
10988

110-
## 💻 Microsoft Learn CLI
89+
## 💻 Microsoft Learn CLI `preview`
90+
91+
[![npm version](https://img.shields.io/npm/v/@microsoft/learn-cli?style=flat-square&logo=npm&label=npm)](https://www.npmjs.com/package/@microsoft/learn-cli)
11192

11293
The [`@microsoft/learn-cli`](https://www.npmjs.com/package/@microsoft/learn-cli) package gives you terminal access to the same tools — search docs, fetch pages, and find code samples — without an MCP client.
11394

114-
```bash
95+
```sh
11596
# Run instantly (no install)
11697
npx @microsoft/learn-cli search "azure functions timeout"
11798

11899
# Or install globally
119100
npm install -g @microsoft/learn-cli
101+
# then use `mslearn`
120102
mslearn search "azure functions timeout"
121-
mslearn code-search "BlobServiceClient" --language python
122-
mslearn fetch "https://learn.microsoft.com/azure/azure-functions/functions-versions"
123103
```
124104

125-
Pass `--json` to get raw JSON output for piping to other tools:
105+
Pass `--json` to get structured JSON output, useful for programmatic processing:
126106

127-
```bash
107+
```sh
128108
mslearn search "azure openai" --json | jq '.results[].title'
129109
```
130110

@@ -143,13 +123,13 @@ See [`cli/README.md`](cli/README.md) for the full command reference.
143123
### Quick Setup
144124

145125
These agent skills are packed in a `microsoft-docs` plugin together with the Learn MCP server itself. If you use Claude Code, run the following commands and restart Claude Code:
146-
```bash
126+
```
147127
/plugin marketplace add microsoftdocs/mcp
148128
/plugin install microsoft-docs@microsoft-docs-marketplace
149129
```
150130

151131
Or if you use GitHub Copilot CLI, run this command:
152-
```bash
132+
```
153133
/plugin install microsoftdocs/mcp
154134
```
155135
Otherwise:
@@ -199,14 +179,6 @@ The Microsoft Learn MCP Server supports quick installation across multiple devel
199179
| **Kiro** | <details><summary>View Config</summary><pre>{<br/> "microsoft-learn": {<br/> "url": "https://learn.microsoft.com/api/mcp"<br/> }<br/>}</pre> </details>| [Kiro MCP Guide](https://kiro.dev/docs/mcp/index) |
200180

201181

202-
### ▶️ Getting Started
203-
204-
1. **For VS Code**: Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)
205-
2. **For Claude Desktop**: After adding the integration, you'll see the MCP tools icon in the chat interface
206-
3. You should see the Learn MCP Server in the list of available tools
207-
4. Try a prompt that tells the agent to use the MCP Server, such as "what are the az cli commands to create an Azure container app according to official Microsoft Learn documentation?"
208-
5. The agent should be able to use the MCP Server tools to complete your query
209-
210182
> ### ⚠️ Building a Custom Client
211183
>
212184
> If your use case requires a direct, programmatic integration, it is essential to understand that MCP is a **dynamic protocol, not a static API**. The available tools and their schemas will evolve.
@@ -247,14 +219,6 @@ When handling questions around how to work with native Microsoft technologies, s
247219
- [Ask questions, share ideas](https://github.com/MicrosoftDocs/mcp/discussions)
248220
- [Create an issue](https://github.com/MicrosoftDocs/mcp/issues)
249221

250-
## 🔮 Future Enhancements
251-
252-
The Microsoft Learn MCP Server team is working on several enhancements:
253-
254-
- Improved telemetry to help inform server enhancements
255-
- Expanding coverage to additional Microsoft documentation sources
256-
- Improved query understanding for more precise results
257-
258222
## 📚 Additional Resources
259223

260224
- [Microsoft Learn MCP Server product documentation](https://learn.microsoft.com/training/support/mcp)

0 commit comments

Comments
 (0)