Skip to content

Commit eb43550

Browse files
committed
docs: incorporate review changes
1 parent 1427ca2 commit eb43550

File tree

2 files changed

+24
-232
lines changed

2 files changed

+24
-232
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ This page describes the three main workflows available and shows you how to use
3636

3737
## Available workflows
3838

39-
AWS MCP Server provides three pre-built workflows designed for different stages of Amplify development:
39+
AWS MCP Server provides three pre-built workflows designed for different stages of Amplify development. These workflows work with both new and existing projects.
4040

4141
| Workflow | Purpose |
4242
| --- | --- |
43-
| **Backend Implementation** | Set up authentication, data models, storage, functions, and AI features |
44-
| **Frontend Integration** | Connect your frontend framework to Amplify backend services |
45-
| **Deployment Guide** | Configure sandbox environments, production deployments, and CI/CD |
43+
| **Backend Implementation** | Add or modify authentication, data models, storage, functions, and AI features in new or existing backends |
44+
| **Frontend Integration** | Add Amplify to an existing frontend app or enhance an app that already uses Amplify |
45+
| **Deployment Guide** | Configure sandbox environments, production deployments, and CI/CD for any Amplify project |
4646

4747
## Backend Implementation workflow
4848

49-
The Backend Implementation workflow helps you set up Amplify backend features following best practices. When you ask your AI assistant to implement a backend feature, it uses this workflow to guide the implementation.
49+
The Backend Implementation workflow helps you add or modify Amplify backend features following best practices. Whether you're starting fresh or adding features to an existing Amplify backend, this workflow guides you through the implementation.
5050

5151
### Supported features
5252

@@ -135,7 +135,7 @@ Help me add an AI summarization feature following Amplify best practices for gen
135135

136136
## Frontend Integration workflow
137137

138-
The Frontend Integration workflow helps you connect your frontend application to Amplify backend services. It provides framework-specific patterns and best practices.
138+
The Frontend Integration workflow helps you add Amplify to your frontend application or enhance an existing Amplify integration. Whether you have an existing React, Vue, Angular, or mobile app that needs Amplify, or you're adding new features to an app that already uses Amplify, this workflow provides framework-specific patterns and best practices.
139139

140140
### Framework patterns
141141

@@ -228,7 +228,7 @@ Walk me through connecting my Kotlin Android app to Amplify with user authentica
228228

229229
## Deployment Guide workflow
230230

231-
The Deployment Guide workflow helps you deploy your Amplify application through different stages, from local development to production.
231+
The Deployment Guide workflow helps you deploy your Amplify application through different stages, from local development to production. This works for new projects as well as existing applications that need deployment configuration or CI/CD setup.
232232

233233
### Sandbox environments
234234

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

Lines changed: 17 additions & 225 deletions
Original file line numberDiff line numberDiff line change
@@ -30,245 +30,37 @@ export function getStaticProps(context) {
3030
};
3131
}
3232

33-
This guide walks you through setting up AWS MCP Server with your AI coding assistant. Once configured, your assistant can access pre-built Amplify workflows, documentation, and execute AWS operations on your behalf.
33+
Follow the [AWS MCP Server setup guide](https://docs.aws.amazon.com/aws-mcp/latest/userguide/getting-started-aws-mcp-server.html) to configure AWS MCP Server with your AI coding assistant. The guide covers:
3434

35-
## Prerequisites
35+
- Installing prerequisites (AWS CLI, uv package manager)
36+
- Configuring your MCP client (Kiro, Cursor, Claude Desktop, and others)
37+
- Setting up AWS credentials and IAM permissions
38+
- Testing your connection
3639

37-
Before you begin, make sure you have the following installed:
40+
## Amplify-specific setup tips
3841

39-
### 1. AWS CLI
42+
Once you have AWS MCP Server configured, here are some tips for Amplify development:
4043

41-
The AWS CLI is required for authentication. If you don't have it installed, follow the [AWS CLI installation guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
44+
### AWS credentials for Amplify
4245

43-
Verify your installation:
46+
If you haven't set up AWS credentials for Amplify development yet, follow the [Configure AWS for local development](/[platform]/start/account-setup/) guide. This ensures you have the right permissions for both AWS MCP Server and Amplify CLI operations.
4447

45-
```bash showLineNumbers={false}
46-
aws --version
47-
```
48-
49-
### 2. uv package manager
50-
51-
AWS MCP Server uses `uvx` to run the MCP proxy. Install `uv` using one of these methods:
52-
53-
```bash title="macOS/Linux" showLineNumbers={false}
54-
curl -LsSf https://astral.sh/uv/install.sh | sh
55-
```
56-
57-
```bash title="Windows (PowerShell)" showLineNumbers={false}
58-
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
59-
```
60-
61-
Verify your installation:
62-
63-
```bash showLineNumbers={false}
64-
uvx --version
65-
```
66-
67-
<Callout info>
68-
69-
For other installation methods, see the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).
70-
71-
</Callout>
72-
73-
### 3. AWS credentials
74-
75-
You need AWS credentials configured locally. If you haven't set up credentials yet, follow the [Configure AWS for local development](/[platform]/start/account-setup/) guide.
76-
77-
## Configure your AI coding assistant
78-
79-
Add the AWS MCP Server configuration to your AI coding assistant. Choose your assistant below:
80-
81-
<Accordion title="Kiro" headingLevel="3">
82-
83-
Add the following to your Kiro MCP configuration file (`.kiro/settings/mcp.json` in your workspace or `~/.kiro/settings/mcp.json` for global configuration):
84-
85-
```json title=".kiro/settings/mcp.json"
86-
{
87-
"mcpServers": {
88-
"aws-mcp": {
89-
"command": "uvx",
90-
"timeout": 100000,
91-
"transport": "stdio",
92-
"args": [
93-
"mcp-proxy-for-aws@latest",
94-
"https://aws-mcp.us-east-1.api.aws/mcp",
95-
"--metadata", "AWS_REGION=us-west-2"
96-
]
97-
}
98-
}
99-
}
100-
```
101-
102-
Replace `us-west-2` with your preferred AWS region.
103-
104-
</Accordion>
105-
106-
<Accordion title="Cursor" headingLevel="3">
107-
108-
Add the following to your Cursor MCP configuration file (`~/.cursor/mcp.json`):
109-
110-
```json title="~/.cursor/mcp.json"
111-
{
112-
"mcpServers": {
113-
"aws-mcp": {
114-
"command": "uvx",
115-
"timeout": 100000,
116-
"transport": "stdio",
117-
"args": [
118-
"mcp-proxy-for-aws@latest",
119-
"https://aws-mcp.us-east-1.api.aws/mcp",
120-
"--metadata", "AWS_REGION=us-west-2"
121-
]
122-
}
123-
}
124-
}
125-
```
126-
127-
Replace `us-west-2` with your preferred AWS region.
128-
129-
</Accordion>
130-
131-
<Accordion title="Claude Desktop" headingLevel="3">
132-
133-
Add the following to your Claude Desktop configuration file:
134-
135-
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
136-
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
137-
138-
```json title="claude_desktop_config.json"
139-
{
140-
"mcpServers": {
141-
"aws-mcp": {
142-
"command": "uvx",
143-
"timeout": 100000,
144-
"transport": "stdio",
145-
"args": [
146-
"mcp-proxy-for-aws@latest",
147-
"https://aws-mcp.us-east-1.api.aws/mcp",
148-
"--metadata", "AWS_REGION=us-west-2"
149-
]
150-
}
151-
}
152-
}
153-
```
48+
### IAM permissions
15449

155-
Replace `us-west-2` with your preferred AWS region.
50+
The base AWS MCP Server permissions allow your AI assistant to access the guided workflows and documentation. For Amplify development, your credentials also need permissions to create and manage Amplify resources.
15651

157-
</Accordion>
52+
If you're using the `AmplifyBackendDeployFullAccess` managed policy for Amplify development, you likely have sufficient permissions. If you encounter permission errors, check with your AWS administrator.
15853

159-
## AWS authentication
54+
### Verify Amplify workflows are available
16055

161-
AWS MCP Server uses your local AWS credentials to authenticate requests. The server uses [SigV4 (Signature Version 4)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) to sign all requests to AWS services.
56+
After setup, verify that the Amplify workflows are accessible by asking your AI assistant:
16257

163-
### Using default credentials
164-
165-
If you have a default AWS profile configured, AWS MCP Server will use it automatically. Your credentials are typically stored in `~/.aws/credentials` or configured through IAM Identity Center.
166-
167-
### Using a named profile
168-
169-
To use a specific AWS profile, set the `AWS_PROFILE` environment variable before starting your AI coding assistant:
170-
171-
```bash showLineNumbers={false}
172-
export AWS_PROFILE=my-profile-name
17358
```
174-
175-
Or add it to your shell configuration file (`.bashrc`, `.zshrc`, etc.) for persistence.
176-
177-
## IAM permissions
178-
179-
Your AWS credentials need the following permissions to use AWS MCP Server. Attach this policy to your IAM user or role:
180-
181-
```json title="IAM Policy"
182-
{
183-
"Version": "2012-10-17",
184-
"Statement": [
185-
{
186-
"Effect": "Allow",
187-
"Action": [
188-
"aws-mcp:InvokeMCP",
189-
"aws-mcp:CallReadOnlyTool",
190-
"aws-mcp:CallReadWriteTool"
191-
],
192-
"Resource": "*"
193-
}
194-
]
195-
}
59+
Which guided workflows are available for Amplify development?
19660
```
19761

198-
<Callout info>
199-
200-
If you're using the `AmplifyBackendDeployFullAccess` managed policy for Amplify development, you may already have the necessary permissions. Check with your AWS administrator if you encounter permission errors.
201-
202-
</Callout>
203-
204-
## Verify your setup
205-
206-
After configuring your AI coding assistant, verify that AWS MCP Server is working correctly:
207-
208-
1. **Restart your AI coding assistant** to load the new MCP configuration.
209-
210-
2. **Ask your assistant about Amplify**. Try a prompt like:
211-
212-
```
213-
Which agent workflows are available for Amplify development?
214-
```
215-
216-
3. **Check for MCP connection**. Your assistant should be able to describe the available Amplify workflows, including Backend Implementation, Frontend Integration, and Deployment Guide.
217-
218-
If your assistant can access information about Amplify workflows, your setup is complete!
219-
220-
## Troubleshooting
221-
222-
<Accordion title="MCP server not connecting" headingLevel="3">
223-
224-
If your AI coding assistant can't connect to AWS MCP Server:
225-
226-
1. Verify `uvx` is installed and in your PATH:
227-
```bash showLineNumbers={false}
228-
which uvx
229-
```
230-
231-
2. Check that your AWS credentials are configured:
232-
```bash showLineNumbers={false}
233-
aws sts get-caller-identity
234-
```
235-
236-
3. Ensure the MCP configuration JSON is valid (no trailing commas, proper quotes).
237-
238-
4. Restart your AI coding assistant after making configuration changes.
239-
240-
</Accordion>
241-
242-
<Accordion title="Permission denied errors" headingLevel="3">
243-
244-
If you see permission errors when using AWS MCP Server:
245-
246-
1. Verify your IAM user or role has the required permissions (see [IAM permissions](#iam-permissions) above).
247-
248-
2. Check that you're using the correct AWS profile:
249-
```bash showLineNumbers={false}
250-
echo $AWS_PROFILE
251-
```
252-
253-
3. Verify your credentials are valid:
254-
```bash showLineNumbers={false}
255-
aws sts get-caller-identity
256-
```
257-
258-
</Accordion>
259-
260-
<Accordion title="Timeout errors" headingLevel="3">
261-
262-
If requests are timing out:
263-
264-
1. Check your network connection to AWS services.
265-
266-
2. Verify the AWS region in your configuration is correct and accessible.
267-
268-
3. Try increasing the `timeout` value in your MCP configuration (the default is 100000ms).
269-
270-
</Accordion>
62+
Your assistant should describe the Backend Implementation, Frontend Integration, and Deployment Guide workflows.
27163

27264
## Next steps
27365

274-
Now that you have AWS MCP Server configured, learn about the [pre-built Amplify workflows](/[platform]/start/mcp-server/amplify-workflows/) available to accelerate your development.
66+
Now that you have AWS MCP Server configured, learn about the [guided workflows](/[platform]/start/mcp-server/amplify-workflows/) available to accelerate your Amplify development.

0 commit comments

Comments
 (0)