You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-97Lines changed: 29 additions & 97 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<!--
2
2
---
3
3
name: Snippy - Intelligent Code Snippet Service with MCP Tools
4
-
description: A serverless code snippet management service using Azure Functions, Durable Functions, Azure OpenAI, Microsoft Fabric and Azure AI Agents.
4
+
description: A serverless code snippet management service using Azure Functions, Durable Functions, Azure OpenAI, Durable Functions and Agent Framework.
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=Azure-Samples/snippy&machine=basicLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json)
@@ -37,8 +36,8 @@ The system uses **Durable Task Scheduler** to orchestrate multi-agent workflows,
37
36
> This repository is intended for learning and demonstration purposes. **Do not** deploy it to production without a thorough security review. At a minimum you should:
@@ -70,7 +69,7 @@ The system uses **Durable Task Scheduler** to orchestrate multi-agent workflows,
70
69
71
70
New to Snippy? Start with our comprehensive **hands-on lab tutorial** that guides you through building the entire application from scratch:
72
71
73
-
📚 **[Snippy Tutorial: Building an AI-Enhanced Code Snippet Manager](lab/TUTORIAL.md)**
72
+
📚 **[Snippy Tutorial: Building an AI-Enhanced Code Snippet Manager](https://azure-samples.github.io/snippy/)**
74
73
75
74
The tutorial covers:
76
75
@@ -83,98 +82,54 @@ The tutorial covers:
83
82
84
83
**Additional Resources:**
85
84
86
-
*[Quick Reference](lab/QUICK_REFERENCE.md) – Essential commands and common tasks
87
-
*[Troubleshooting Guide](lab/TROUBLESHOOTING.md) – Solutions to common issues
85
+
*[Quick Reference](https://azure-samples.github.io/snippy/QUICK_REFERENCE/) – Essential commands and common tasks
86
+
*[Troubleshooting Guide](https://azure-samples.github.io/snippy/TROUBLESHOOTING/) – Solutions to common issues
88
87
89
88
Whether you're new to Azure Functions, MCP tools, or AI agent development, the lab provides a structured learning path with hands-on experience.
90
-
91
89
---
92
90
93
91
## Getting Started
94
92
95
-
You can run Snippy in **GitHub Codespaces**, **VS Code Dev Containers**, or your **local environment**. The fastest path is Codespaces.
96
-
97
-
> Snippy requires an Azure region that supports *text‑embedding‑3‑small* (or a compatible embeddings model) **and** Azure AI Agents. The `azd` workflow prompts you for a region; we recommend **eastus** for best availability.
98
-
99
-
### GitHub Codespaces
100
-
101
-
1. Click **Open in Codespaces** above (first badge) – the container build may take a few minutes.
102
-
2. When the terminal appears, sign in:
103
-
104
-
```bash
105
-
azd auth login --use-device-code
106
-
```
107
-
3. Launch the stack:
93
+
### Prerequisites
108
94
109
-
```bash
110
-
azd up
111
-
```
112
-
4. Once deployment completes, copy the printed MCP URL and open GitHub Copilot Chat → *Agent* mode to try commands like “Save this snippet as **hello‑world**”.
95
+
* Azure subscription with permissions to create resources
96
+
*[azd CLI](https://aka.ms/install-azd) installed
97
+
* Choose your development environment:
98
+
-**GitHub Codespaces** (fastest, no local setup required)
99
+
-**VS Code Dev Containers** (requires [Docker Desktop](https://www.docker.com/products/docker-desktop))
*Create an Azure AD app registration for OAuth authentication
151
-
*Provision all Azure resources (Functions, Cosmos DB, OpenAI, etc.)
121
+
The `azd up` command will:
122
+
* Prompt for an Azure region (recommend **eastus** or **swedencentral**)
123
+
*Provision all resources (Functions, Cosmos DB, Azure OpenAI, DTS)
124
+
*Create an Azure AD app registration for authentication
152
125
* Deploy the application code
153
126
154
-
The CLI prints the Function App URL, MCP endpoint and system key when finished. To remove all resources later:
155
-
156
-
```bash
157
-
azd down --purge
158
-
```
159
-
160
-
> **Note**: The first run automatically creates an Azure AD app registration with OAuth2 scope `access_as_user` for authentication.
161
-
162
-
### Local Development with Emulators
127
+
When complete, the Function App URL and MCP endpoint will be displayed. See the [tutorial](https://azure-samples.github.io/snippy/) for detailed instructions on local development, testing with emulators, and monitoring orchestrations.
163
128
164
-
For local development, Snippy uses the **Durable Task Scheduler (DTS) emulator** and **Azurite** for storage.
165
-
166
-
#### With Docker (Recommended)
167
-
168
-
The easiest way to run both emulators:
169
-
170
-
```bash
171
-
# Start both emulators
172
-
docker compose up -d
129
+
---
173
130
174
-
# Generate local.settings.json from your Azure environment
0 commit comments