Skip to content

Commit 1427ca2

Browse files
committed
docs: guidance documentation updates
1 parent 0fa1701 commit 1427ca2

File tree

2 files changed

+92
-23
lines changed

2 files changed

+92
-23
lines changed

src/pages/[platform]/start/mcp-server/amplify-workflows/index.mdx

Lines changed: 91 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { getCustomStaticPath } from '@/utils/getCustomStaticPath';
22

33
export const meta = {
4-
title: 'Pre-built Amplify workflows',
5-
description: 'Learn about the pre-built workflows available in AWS MCP Server for building Amplify applications.',
4+
title: 'Guided workflows',
5+
description: 'Learn about the guided workflows available in AWS MCP Server for building Amplify applications.',
66
route: '/[platform]/start/mcp-server/amplify-workflows',
77
platforms: [
88
'android',
@@ -62,7 +62,7 @@ The workflow guides you through setting up Amplify Auth, including:
6262

6363
**Example prompt:**
6464
```
65-
Set up authentication for my app with email sign-in and Google social login.
65+
Guide me through setting up Amplify authentication with email sign-in and Google social login.
6666
```
6767

6868
</Accordion>
@@ -79,8 +79,8 @@ The workflow helps you design and implement your data layer:
7979

8080
**Example prompt:**
8181
```
82-
Create a data model for a blog with posts, comments, and user profiles.
83-
Posts should only be editable by their authors.
82+
Help me create a data model following Amplify best practices for a blog with posts,
83+
comments, and user profiles. Posts should only be editable by their authors.
8484
```
8585

8686
</Accordion>
@@ -96,7 +96,7 @@ The workflow guides storage implementation:
9696

9797
**Example prompt:**
9898
```
99-
Add file storage so users can upload profile pictures with a 5MB limit.
99+
Walk me through adding file storage so users can upload profile pictures with a 5MB limit.
100100
```
101101

102102
</Accordion>
@@ -112,7 +112,7 @@ The workflow helps you create and deploy Lambda functions:
112112

113113
**Example prompt:**
114114
```
115-
Create a function that sends a welcome email when a new user signs up.
115+
Guide me through creating a Lambda function that sends a welcome email when a new user signs up.
116116
```
117117

118118
</Accordion>
@@ -128,7 +128,7 @@ The workflow guides AI/ML feature integration:
128128

129129
**Example prompt:**
130130
```
131-
Add an AI feature that summarizes long articles for users.
131+
Help me add an AI summarization feature following Amplify best practices for generative AI.
132132
```
133133

134134
</Accordion>
@@ -151,7 +151,7 @@ The workflow adapts its guidance based on your frontend framework:
151151

152152
**Example prompt:**
153153
```
154-
Connect my React app to the Amplify backend and add a sign-in page.
154+
Help me connect my React app to Amplify following best practices. I need a sign-in page and protected routes.
155155
```
156156

157157
</Accordion>
@@ -165,7 +165,7 @@ Connect my React app to the Amplify backend and add a sign-in page.
165165

166166
**Example prompt:**
167167
```
168-
Set up Amplify in my Vue app and create a protected dashboard route.
168+
Guide me through setting up Amplify in my Vue app with a protected dashboard route.
169169
```
170170

171171
</Accordion>
@@ -179,7 +179,7 @@ Set up Amplify in my Vue app and create a protected dashboard route.
179179

180180
**Example prompt:**
181181
```
182-
Add offline support to my React Native app so users can work without internet.
182+
Walk me through adding offline support to my React Native app following Amplify best practices.
183183
```
184184

185185
</Accordion>
@@ -193,7 +193,7 @@ Add offline support to my React Native app so users can work without internet.
193193

194194
**Example prompt:**
195195
```
196-
Set up authentication in my Flutter app with the Amplify Authenticator widget.
196+
Help me set up authentication in my Flutter app using the Amplify Authenticator widget.
197197
```
198198

199199
</Accordion>
@@ -207,7 +207,7 @@ Set up authentication in my Flutter app with the Amplify Authenticator widget.
207207

208208
**Example prompt:**
209209
```
210-
Add real-time data sync to my SwiftUI app using Amplify DataStore.
210+
Guide me through adding real-time data sync to my SwiftUI app following Amplify best practices.
211211
```
212212

213213
</Accordion>
@@ -221,7 +221,7 @@ Add real-time data sync to my SwiftUI app using Amplify DataStore.
221221

222222
**Example prompt:**
223223
```
224-
Connect my Kotlin Android app to Amplify and implement user authentication.
224+
Walk me through connecting my Kotlin Android app to Amplify with user authentication.
225225
```
226226

227227
</Accordion>
@@ -241,7 +241,7 @@ The workflow guides you through setting up personal cloud sandbox environments f
241241

242242
**Example prompt:**
243243
```
244-
Set up a sandbox environment so I can test my backend changes.
244+
Guide me through setting up an Amplify sandbox environment for testing backend changes.
245245
```
246246

247247
### Production deployment
@@ -255,7 +255,7 @@ The workflow helps you deploy to production:
255255

256256
**Example prompt:**
257257
```
258-
Deploy my app to production with a custom domain.
258+
Walk me through deploying my Amplify app to production with a custom domain.
259259
```
260260

261261
### CI/CD integration
@@ -269,7 +269,7 @@ The workflow guides continuous integration and deployment setup:
269269

270270
**Example prompt:**
271271
```
272-
Set up CI/CD so my app automatically deploys when I push to the main branch.
272+
Help me set up CI/CD following Amplify best practices so my app deploys automatically when I push to main.
273273
```
274274

275275
## Practical example: Building a fullstack app
@@ -281,7 +281,7 @@ Here's an example of how you might use AWS MCP Server to build a complete Amplif
281281
Start by describing your application to your AI assistant:
282282

283283
```
284-
I want to build a task management app. Users should be able to:
284+
Help me build a task management app following Amplify best practices. Users should be able to:
285285
- Sign up and sign in with email
286286
- Create, edit, and delete their own tasks
287287
- Mark tasks as complete
@@ -298,8 +298,8 @@ Your AI assistant uses the **Backend Implementation workflow** to:
298298
Next, ask your assistant to connect your frontend:
299299

300300
```
301-
Connect my React app to the backend. I want a sign-in page and a
302-
dashboard that shows the user's tasks.
301+
Guide me through connecting my React app to the Amplify backend. I need a sign-in page
302+
and a dashboard that shows the user's tasks with real-time updates.
303303
```
304304

305305
Your AI assistant uses the **Frontend Integration workflow** to:
@@ -313,8 +313,8 @@ Your AI assistant uses the **Frontend Integration workflow** to:
313313
Finally, deploy your application:
314314

315315
```
316-
Set up deployment so the app deploys automatically when I push to GitHub.
317-
Configure preview deployments for pull requests.
316+
Walk me through setting up Amplify deployment so the app deploys automatically when I push
317+
to GitHub. I also want preview deployments for pull requests.
318318
```
319319

320320
Your AI assistant uses the **Deployment Guide workflow** to:
@@ -338,6 +338,75 @@ To get the best results from AWS MCP Server, keep these tips in mind:
338338
- **Ask follow-up questions** if you need clarification on any step
339339
- **Request explanations** if you want to understand why certain patterns are recommended
340340

341+
## Triggering workflows automatically
342+
343+
The guided workflows are designed to activate naturally when you use certain phrases in your prompts:
344+
345+
- **"Guide me through..."** or **"Walk me through..."** - Signals you want step-by-step guidance
346+
- **"...following Amplify best practices"** - Triggers the AI to look up recommended patterns
347+
- **"Help me set up..."** - Indicates you want structured assistance
348+
349+
These phrases help your AI assistant recognize that it should use the pre-built workflows rather than generating ad-hoc solutions.
350+
351+
### Optional: Steering files for teams
352+
353+
For teams that want guaranteed consistency across all developers, you can add steering files that explicitly instruct the AI to always use the workflows. This is optional—the prompt patterns above work well for most use cases.
354+
355+
<Accordion title="Kiro" headingLevel="3">
356+
357+
Create a steering file at `.kiro/steering/amplify.md`:
358+
359+
```markdown title=".kiro/steering/amplify.md"
360+
# Amplify Development Guidelines
361+
362+
When working on Amplify projects, use the AWS MCP Server guided workflows:
363+
364+
- For backend features (auth, data, storage, functions, AI), call `retrieve_agent_sop` with `amplify-backend-implementation`
365+
- For frontend integration, call `retrieve_agent_sop` with `amplify-frontend-integration`
366+
- For deployment tasks, call `retrieve_agent_sop` with `amplify-deployment-guide`
367+
```
368+
369+
</Accordion>
370+
371+
<Accordion title="Claude Code" headingLevel="3">
372+
373+
Add to your `CLAUDE.md` file in the project root:
374+
375+
```markdown title="CLAUDE.md"
376+
# Amplify Development Guidelines
377+
378+
When working on Amplify projects, use the AWS MCP Server guided workflows:
379+
380+
- For backend features (auth, data, storage, functions, AI), call `retrieve_agent_sop` with `amplify-backend-implementation`
381+
- For frontend integration, call `retrieve_agent_sop` with `amplify-frontend-integration`
382+
- For deployment tasks, call `retrieve_agent_sop` with `amplify-deployment-guide`
383+
```
384+
385+
</Accordion>
386+
387+
<Accordion title="Cursor" headingLevel="3">
388+
389+
Create a rules file at `.cursor/rules/amplify.mdc`:
390+
391+
```markdown title=".cursor/rules/amplify.mdc"
392+
---
393+
description: Amplify development guidelines
394+
globs:
395+
- "amplify/**"
396+
- "src/**"
397+
---
398+
399+
# Amplify Development Guidelines
400+
401+
When working on Amplify projects, use the AWS MCP Server guided workflows:
402+
403+
- For backend features (auth, data, storage, functions, AI), call `retrieve_agent_sop` with `amplify-backend-implementation`
404+
- For frontend integration, call `retrieve_agent_sop` with `amplify-frontend-integration`
405+
- For deployment tasks, call `retrieve_agent_sop` with `amplify-deployment-guide`
406+
```
407+
408+
</Accordion>
409+
341410
## Next steps
342411

343412
Now that you understand the pre-built workflows, try using them in your next Amplify project:

src/pages/[platform]/start/mcp-server/set-up-mcp/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ After configuring your AI coding assistant, verify that AWS MCP Server is workin
210210
2. **Ask your assistant about Amplify**. Try a prompt like:
211211

212212
```
213-
What pre-built workflows are available for Amplify development?
213+
Which agent workflows are available for Amplify development?
214214
```
215215

216216
3. **Check for MCP connection**. Your assistant should be able to describe the available Amplify workflows, including Backend Implementation, Frontend Integration, and Deployment Guide.

0 commit comments

Comments
 (0)