Skip to content

Commit b2f242d

Browse files
committed
docs: refresh lab instructions with updated screenshots and Copilot UI changes
1 parent b5bcc78 commit b2f242d

File tree

1 file changed

+21
-29
lines changed

1 file changed

+21
-29
lines changed

docs/lab-instructions.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ After signing into GitHub, go back to VS Code and complete the Copilot setup:
9595

9696
4. [ ] Click the **account icon** (bottom right) → **Sign in to use Copilot.**
9797

98-
!IMAGE[SnippyLab-GH-VSCode-SignIn](https://github.com/Azure-Samples/snippy/blob/docs/add-lab-instructions/images/SnippyLab-GH-VSCode-SignIn.png?raw=true)
98+
!IMAGE[SnippyLab-GH-VSCode-SignIn](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-GH-VSCode-SignIn.png)
9999

100100
5. [ ] Select **Continue with GitHub**
101101

@@ -640,12 +640,9 @@ Now that *local.settings.json* points to your actual Azure resources provisioned
640640

641641
>[!alert] This may take a minute to start.
642642

643-
2. [] Look for output indicating the Functions host has started successfully. You should see your functions listed, including the HTTP endpoints and the MCP tool trigger functions, as shown below:
643+
2. [] Look for output indicating the Functions host has started successfully. You should see your functions listed, including the HTTP endpoints, the MCP tool trigger functions, and even an orchestration (we'll run this soon), as shown below:
644644

645-
!IMAGE[0mxqfmje.jpg](instructions291323/0mxqfmje.jpg)
646-
647-
> [!note]
648-
> The Functions runtime is using file-based secret storage via the "AzureWebJobsSecretStorageType": "files" setting, eliminating the need for Azurite or other storage emulators.
645+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-FuncStart.png)
649646

650647
> [!knowledge] (Optional) 9.1 Test with REST Client (End-to-End Smoke test)
651648
>
@@ -667,7 +664,7 @@ Now that *local.settings.json* points to your actual Azure resources provisioned
667664
> 5. Test a few more operations to ensure everything works:
668665
> - Save a more complex snippet using the **### Save a complex snippet** request
669666
> - Retrieve it using the corresponding GET request
670-
> - Try the AI agent functions by running the **### Generate wiki documentation** or **### Generate code style guide** requests
667+
> - Try the AI agent functions by running the **### Generate wiki** or **### Generate code style guide** requests
671668
>
672669
> 6. For the agent-based functions (wiki and code style guide), note that these may take longer to execute (10-30 seconds) as they involve creating an AI agent that analyzes your saved snippets.
673670
>
@@ -683,10 +680,10 @@ Now, connect GitHub Copilot Chat to your *locally running* Function App's MCP en
683680
1. [] **Verify MCP Server Configuration**:
684681
- In VS Code, open the **.vscode/mcp.json** file
685682
- You should see the **local-snippy** server already configured
686-
- If you see a "Running" status with tools count (e.g., "✓ Running | Stop | Restart | 4 tools"), the server is already connected
683+
- If you see a "Running" status with tools count (e.g., "✓ Running | Stop | Restart | 5 tools"), the server is already connected
687684
- If not connected, select the **Start** button in the file (appears at the top of the JSON configuration)
688685

689-
!IMAGE[11a-mcp-local-start.png](instructions291323/11a-mcp-local-start.png)
686+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-MCP-Local-Start.png)
690687

691688
2. [] **View MCP Server Logs** (optional but helpful):
692689
- Open the Command Palette by selecting **Ctrl+Shift+P** or **View > Command Palette** from the toolbar.
@@ -707,7 +704,7 @@ Now, connect GitHub Copilot Chat to your *locally running* Function App's MCP en
707704

708705
- At the bottom of the chat panel, select **Select Tools...** (or select **Ctrl+Shift+/**)
709706

710-
!IMAGE[12b-mcp-ghcp-tools.png](instructions291323/12b-mcp-ghcp-tools.png)
707+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-MCP-Tools-Local.png)
711708

712709
- Make sure *MCP Server: local-snippy* and all its tools are checked
713710
- Select **Escape** or select **OK** to confirm your selection
@@ -742,16 +739,16 @@ Now, connect GitHub Copilot Chat to your *locally running* Function App's MCP en
742739
5. [] **Test the *save_snippet* Tool**:
743740
- [] Open any code file (e.g., **src/agents/durable_agents.py**).
744741
- [] Select some interesting code sections (or it'll take the entire file as a snippet, which is fine, as well).
745-
- [] In Copilot Chat, enter `save this snippet as ai-agents-service-usage`, then select **Enter** or **Send**.
746-
- [] If prompted by Copilot to use the **save_snippet** tool, select **Continue**.
742+
- [] In Copilot Chat, enter `#local-snippy save this snippet as ai-agents-service-usage`, then select **Enter** or **Send**.
743+
- [] If prompted by Copilot to use the **save_snippet** tool, select **Allow**.
747744

748-
!IMAGE[13-mcp-ghcp-save.png](instructions291323/13-mcp-ghcp-save.png)
749-
745+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-SaveSnippet-Local.png)
746+
750747
6. [] **Test the *get_snippet* Tool**:
751748
- [] In Copilot Chat, lets try explicity using the server and enter `#local-snippy get the snippet named ai-agents-service-usage`, then select **Enter** or **Send**.
752-
- [] Copilot will suggest using the **get_snippet** tool - Select **Continue**.
749+
- [] Copilot will suggest using the **get_snippet** tool - Select **Allow**.
753750

754-
!IMAGE[14-mcp-ghcp-get.png](instructions291323/14-mcp-ghcp-get.png)
751+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-GetSnippet-Local.png)
755752

756753
7. [] **Experiment with Advanced AI Agent Tools**:
757754
- Try these prompts (no need to select code first):
@@ -767,8 +764,6 @@ Now, connect GitHub Copilot Chat to your *locally running* Function App's MCP en
767764

768765
- [] Once they are done, open the files and Preview the generated Markdown (*Ctrl+K V*)
769766

770-
!IMAGE[15-deep-wiki.png](instructions291323/15-deep-wiki.png)
771-
772767
8. [] **Check Function Logs**:
773768

774769
- In the terminal where `func start` is running, you'll see logs for each tool invocation
@@ -790,9 +785,9 @@ Now you'll test the `generate_comprehensive_documentation` tool, which orchestra
790785
2. [] **Trigger the Multi-Agent Orchestration**:
791786
- In GitHub Copilot Chat (with the **local-snippy** MCP server active), enter the following prompt:
792787

793-
`Generate comprehensive documentation with emphasis on the MCP tools, vector search capabilities and code style. Save in a new file called comprehensive-documentation.md`
788+
`#local-snippy Generate comprehensive documentation with emphasis on the MCP tools, vector search capabilities and code style. Save in a new file called comprehensive-documentation.md`
794789

795-
- Select **Continue** when Copilot asks to use the **generate_comprehensive_documentation** tool
790+
- Select **Allow** when Copilot asks to use the **generate_comprehensive_documentation** tool
796791

797792
3. [] **Monitor the Orchestration**:
798793
- Switch to your browser at `http://localhost:8082/`
@@ -889,7 +884,9 @@ Finally, configure VS Code and Copilot Chat to use the tools running on your *de
889884

890885
>[!note]The output will be a long string - **copy this value**. This is your **<system-key>** required for calling the MCP endpoint.
891886

892-
2. [] **Add Cloud Endpoint to *.vscode/mcp.json*:** After retrieving your Function App name and MCP system key, you can now configure the cloud endpoint in *.vscode/mcp.json*.
887+
2. [] **Add Cloud Endpoint to *.vscode/mcp.json*:**
888+
889+
After retrieving your Function App name and MCP system key, you can now configure the cloud endpoint in *.vscode/mcp.json*.
893890

894891
Stop the **local-snippy** server if it is still running.
895892

@@ -913,7 +910,7 @@ Finally, configure VS Code and Copilot Chat to use the tools running on your *de
913910

914911
This setup allows the cloud-hosted MCP to receive and stream events securily.
915912

916-
!IMAGE[16-remote-snippy.png](instructions291323/16-remote-snippy.png)
913+
!IMAGE[](https://raw.githubusercontent.com/Azure-Samples/snippy/main/images/SnippyLab-MCP-Remote.png)
917914

918915
3. [] **Switch Copilot to Cloud Server:**
919916

@@ -925,14 +922,9 @@ Finally, configure VS Code and Copilot Chat to use the tools running on your *de
925922
Repeat the tests from earlier, but this time with the *remote-snippy* server:
926923

927924
* Select some code.
928-
* Ask Copilot: `save the selected snippet as my-cloud-mcp-test`
929-
930-
>[!alert] If you see errors on **local-snippy**, open *.vscode/mcp.json*, delete the block of text for **local-snippy**, then try again. You may need to start a new chat if it continues to attempt with **local-snippy**.
931-
>
932-
>!IMAGE[74sc3vu8.jpg](instructions291323/74sc3vu8.jpg)
933-
925+
* Ask Copilot: `#remote-snippy save the selected snippet as my-cloud-mcp-test`
934926
* Confirm the tool usage.
935-
* Ask Copilot: `get the snippet named my-cloud-mcp-test`
927+
* Ask Copilot: `#remote-snippy get the snippet named my-cloud-mcp-test`
936928
* Try other tools like **deep_wiki** as we did earlier.
937929

938930
Verify that the tools work correctly by interacting with your deployed Azure Function App.

0 commit comments

Comments
 (0)