mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-16 06:05:12 +00:00
Add Learn CLI option to microsoft-docs skills (#1003)
* Add Learn CLI option to microsoft-docs skills * avoid context fork * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Tianqi Zhang
GitHub
@@ -1,7 +1,7 @@
|
||||
---
|
||||
name: microsoft-code-reference
|
||||
description: Look up Microsoft API references, find working code samples, and verify SDK code is correct. Use when working with Azure SDKs, .NET libraries, or Microsoft APIs—to find the right method, check parameters, get working examples, or troubleshoot errors. Catches hallucinated methods, wrong signatures, and deprecated patterns by querying official docs.
|
||||
compatibility: Requires Microsoft Learn MCP Server (https://learn.microsoft.com/api/mcp)
|
||||
compatibility: Works best with Microsoft Learn MCP Server (https://learn.microsoft.com/api/mcp). Can also use the mslearn CLI as a fallback.
|
||||
---
|
||||
|
||||
# Microsoft Code Reference
|
||||
@@ -76,3 +76,24 @@ Before generating code using Microsoft SDKs, verify it's correct:
|
||||
3. **Find working sample** — `microsoft_code_sample_search(query: "[task]", language: "[lang]")`
|
||||
|
||||
For simple lookups, step 1 alone may suffice. For complex API usage, complete all three steps.
|
||||
|
||||
## CLI Alternative
|
||||
|
||||
If the Learn MCP server is not available, use the `mslearn` CLI from a terminal or shell (for example, Bash, PowerShell, or cmd) instead:
|
||||
|
||||
```sh
|
||||
# Run directly (no install needed)
|
||||
npx @microsoft/learn-cli search "BlobClient UploadAsync Azure.Storage.Blobs"
|
||||
|
||||
# Or install globally, then run
|
||||
npm install -g @microsoft/learn-cli
|
||||
mslearn search "BlobClient UploadAsync Azure.Storage.Blobs"
|
||||
```
|
||||
|
||||
| MCP Tool | CLI Command |
|
||||
|----------|-------------|
|
||||
| `microsoft_docs_search(query: "...")` | `mslearn search "..."` |
|
||||
| `microsoft_code_sample_search(query: "...", language: "...")` | `mslearn code-search "..." --language ...` |
|
||||
| `microsoft_docs_fetch(url: "...")` | `mslearn fetch "..."` |
|
||||
|
||||
Pass `--json` to `search` or `code-search` to get raw JSON output for further processing.
|
||||
|
||||
@@ -21,6 +21,27 @@ Use these tools for **everything on learn.microsoft.com** — Azure, .NET, M365,
|
||||
|
||||
Use `microsoft_docs_fetch` after search when you need complete tutorials, all config options, or when search excerpts are truncated.
|
||||
|
||||
### CLI Alternative
|
||||
|
||||
If the Learn MCP server is not available, use the `mslearn` CLI from your terminal or shell (for example, Bash, PowerShell, or cmd) instead:
|
||||
|
||||
```bash
|
||||
# Run directly (no install needed)
|
||||
npx @microsoft/learn-cli search "BlobClient UploadAsync Azure.Storage.Blobs"
|
||||
|
||||
# Or install globally, then run
|
||||
npm install -g @microsoft/learn-cli
|
||||
mslearn search "BlobClient UploadAsync Azure.Storage.Blobs"
|
||||
```
|
||||
|
||||
| MCP Tool | CLI Command |
|
||||
|----------|-------------|
|
||||
| `microsoft_docs_search(query: "...")` | `mslearn search "..."` |
|
||||
| `microsoft_code_sample_search(query: "...", language: "...")` | `mslearn code-search "..." --language ...` |
|
||||
| `microsoft_docs_fetch(url: "...")` | `mslearn fetch "..."` |
|
||||
|
||||
Pass `--json` to `search` or `code-search` to get raw JSON output for further processing.
|
||||
|
||||
---
|
||||
|
||||
## Exceptions: When to Use Other Tools
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
name: microsoft-skill-creator
|
||||
description: Create agent skills for Microsoft technologies using Learn MCP tools. Use when users want to create a skill that teaches agents about any Microsoft technology, library, framework, or service (Azure, .NET, M365, VS Code, Bicep, etc.). Investigates topics deeply, then generates a hybrid skill storing essential knowledge locally while enabling dynamic deeper investigation.
|
||||
context: fork
|
||||
compatibility: Requires Microsoft Learn MCP Server (https://learn.microsoft.com/api/mcp)
|
||||
compatibility: Works best with Microsoft Learn MCP Server (https://learn.microsoft.com/api/mcp). Can also use the mslearn CLI as a fallback.
|
||||
---
|
||||
|
||||
# Microsoft Skill Creator
|
||||
@@ -37,6 +37,27 @@ skill-name/
|
||||
| `microsoft_docs_fetch` | Get full page content | Deep dive into important pages |
|
||||
| `microsoft_code_sample_search` | Find code examples | Get implementation patterns |
|
||||
|
||||
### CLI Alternative
|
||||
|
||||
If the Learn MCP server is not available, use the `mslearn` CLI from a terminal or shell (for example, Bash, PowerShell, or cmd) instead:
|
||||
|
||||
```bash
|
||||
# Run directly (no install needed)
|
||||
npx @microsoft/learn-cli search "semantic kernel overview"
|
||||
|
||||
# Or install globally, then run
|
||||
npm install -g @microsoft/learn-cli
|
||||
mslearn search "semantic kernel overview"
|
||||
```
|
||||
|
||||
| MCP Tool | CLI Command |
|
||||
|----------|-------------|
|
||||
| `microsoft_docs_search(query: "...")` | `mslearn search "..."` |
|
||||
| `microsoft_code_sample_search(query: "...", language: "...")` | `mslearn code-search "..." --language ...` |
|
||||
| `microsoft_docs_fetch(url: "...")` | `mslearn fetch "..."` |
|
||||
|
||||
Generated skills should include this same CLI fallback table so agents can use either path.
|
||||
|
||||
## Creation Process
|
||||
|
||||
### Step 1: Investigate the Topic
|
||||
@@ -214,4 +235,16 @@ See [getting-started/hello-kernel.cs](sample_codes/getting-started/hello-kernel.
|
||||
| Plugin development | `microsoft_docs_search(query="semantic kernel plugins custom functions")` |
|
||||
| Planners | `microsoft_docs_search(query="semantic kernel planner")` |
|
||||
| Memory | `microsoft_docs_fetch(url="https://learn.microsoft.com/en-us/semantic-kernel/frameworks/agent/agent-memory")` |
|
||||
|
||||
## CLI Alternative
|
||||
|
||||
If the Learn MCP server is not available, use the `mslearn` CLI instead:
|
||||
|
||||
| MCP Tool | CLI Command |
|
||||
|----------|-------------|
|
||||
| `microsoft_docs_search(query: "...")` | `mslearn search "..."` |
|
||||
| `microsoft_code_sample_search(query: "...", language: "...")` | `mslearn code-search "..." --language ...` |
|
||||
| `microsoft_docs_fetch(url: "...")` | `mslearn fetch "..."` |
|
||||
|
||||
Run directly with `npx @microsoft/learn-cli <command>` or install globally with `npm install -g @microsoft/learn-cli`.
|
||||
```
|
||||
|
||||
@@ -2,6 +2,18 @@
|
||||
|
||||
Ready-to-use templates for different types of Microsoft technologies.
|
||||
|
||||
## CLI Alternative for MCP Tools
|
||||
|
||||
All templates below use MCP tool calls (e.g., `microsoft_docs_search`, `microsoft_docs_fetch`, `microsoft_code_sample_search`). If the Learn MCP server is not available, replace them with CLI equivalents:
|
||||
|
||||
| MCP Tool | CLI Command |
|
||||
|----------|-------------|
|
||||
| `microsoft_docs_search(query: "...")` | `mslearn search "..."` |
|
||||
| `microsoft_code_sample_search(query: "...", language: "...")` | `mslearn code-search "..." --language ...` |
|
||||
| `microsoft_docs_fetch(url: "...")` | `mslearn fetch "..."` |
|
||||
|
||||
Run directly with `npx @microsoft/learn-cli <command>` or install globally with `npm install -g @microsoft/learn-cli`.
|
||||
|
||||
## Template 1: SDK/Library Skill
|
||||
|
||||
For client libraries, SDKs, and programming frameworks.
|
||||
|
||||
Reference in New Issue
Block a user