@chinchillaenterprises/mcp-amplify-docs
v1.7.4
Published
MCP server providing AWS Amplify documentation and code generation tools
Downloads
47
Maintainers
Readme
MCP Amplify Docs
An MCP (Model Context Protocol) server that provides AWS Amplify documentation, code examples, and implementation patterns directly within Claude.
🚀 v1.6.0 - Real-World Lambda + DynamoDB Patterns
NEW: Production-tested patterns from actual deployed apps:
📍 Real-World Lambda + DynamoDB - ACTUAL working pattern:
- Correct import path:
@aws-amplify/backend/function/runtime - Use
process.envdirectly (NOT$amplify/env) - Always specify
authMode: 'iam'for Lambda functions - Dependencies in root
package.jsononly
- Correct import path:
🎯 Enhanced Function Best Practices - New
real-world-lambda-dynamodbpattern- Complete working examples from production apps
- Common errors and their solutions
- Proper project structure
Previous Updates (v1.5.0)
This version implements a hybrid approach to prevent common client-side errors:
📍 Automatic Client-Side Reminders - EVERY response now includes critical reminders:
Amplify.configure(outputs)requirement- Auth mode specification for multi-auth setups
- Use
publicApiKeyinstead ofguestfor public access
🎯 New Implementation Checklist Tool -
get_amplify_implementation_checklist- Comprehensive checklists for auth, storage, data, functions
- Complete working examples with proper error handling
- Auth mode decision trees
This update specifically addresses the three most common Amplify errors that occur in browser consoles, ensuring Claude provides correct implementation guidance from the start.
What it does
This MCP server gives Claude instant access to AWS Amplify best practices and code generation for:
- Authentication (Cognito)
- Storage (S3)
- Data (GraphQL/DynamoDB)
- Functions (Lambda)
- Hosting (Deployment)
Installation
From NPM (Recommended)
# Install with user scope
claude mcp add amplify-docs -s user -- npx @chinchillaenterprises/mcp-amplify-docs
# Start Claude to use the tools
claudeFor Development
# Clone and build
cd mcp-amplify-docs
npm install
npm run build
# Add to Claude for testing
claude mcp add amplify-docs-dev -s user -- node $(pwd)/dist/index.jsAvailable Tools
🔐 Authentication
get_auth_setup
Returns backend configuration for authentication:
- basic - Simple email authentication
- advanced - Full-featured auth with MFA, groups
- custom-attributes - Custom user profile fields
- user-groups - Role-based access control
- mfa - Multi-factor authentication setup
- external-providers - Social & enterprise SSO
- triggers - Lambda customization hooks
- email-customization - Branded auth emails
- guest-access - Unauthenticated access
- cdk-overrides - Advanced Cognito customization
get_auth_client_code
Provides client-side implementation examples:
- sign-up - User registration flow
- sign-in - Authentication flow
- sign-out - End user sessions
- manage-attributes - User profile management
- mfa-setup - Configure MFA for users
- password-management - Reset & update passwords
- session-management - Handle tokens & sessions
- webauthn - Passkey authentication
- hub-events - Listen to auth state changes
- admin-actions - Server-side user management
- user-auth-flow - Flexible auth methods
📁 Storage
get_storage_setup
Returns backend configuration for storage:
- basic - Simple storage setup
- file-access - Path-based access rules
- authorization - User type permissions
- multiple-buckets - Multi-bucket configuration
- triggers - Lambda function triggers
- custom-bucket - Use existing S3 buckets
- transfer-acceleration - Fast uploads
- cors - Cross-origin configuration
get_storage_operations
Provides client-side implementation examples:
- upload - File upload with progress
- download - Get files and URLs
- list - Browse files and folders
- properties - File metadata
- remove - Delete files
- copy - Duplicate files
- ui-components - React components
📊 Data
get_data_setup
Returns backend configuration for data:
- basic - Simple GraphQL setup
- client-config - Client configuration
- fields - Model field definitions
- relationships - Model relationships
- identifiers - Custom identifiers
- indexes - Database indexes
- auth-public - Public access
- auth-owner - Owner-based access
- auth-groups - Group-based access
- auth-custom - Custom authorization
- custom-queries - Custom GraphQL operations
- validation - Field validation rules
get_data_client_code
Provides client-side data operation examples:
- create - Create records
- read - Query data
- update - Update records
- delete - Delete records
- subscriptions - Real-time updates
- realtime - Live data sync
- pagination - Handle large datasets
- filtering - Search and filter
get_data_integrations
External service integrations:
- opensearch - Search integration
- eventbridge - Event streaming
- bedrock - AI/ML services
- rekognition - Image analysis
- translate - Language translation
- polly - Text-to-speech
- http-api - REST API integration
- sql-database - SQL database connection
- files - File handling
- ssr - Server-side rendering
- optimistic-ui - Optimistic updates
- events - Event handling
- logging - Application logging
⚡ Functions
get_function_setup
Returns backend configuration for functions:
- basic - Simple function setup
- environment-vars - Environment variable configuration
- secrets - Secure secret management
- configuration - Lambda settings (timeout, memory)
- scheduling - Cron and scheduled functions
- layers - Lambda layer configuration
- access - Grant permissions to resources
- client-config - Use Amplify client in functions
- custom-languages - Python and Go functions
- streaming-logs - Real-time log debugging
get_function_triggers
Provides Lambda trigger examples:
- auth-presignup - Email domain filtering
- auth-postconfirmation - User onboarding
- auth-pretoken - Customize ID tokens
- auth-custom-message - Custom emails/SMS
- auth-custom-challenge - Custom authentication
- kinesis - Stream processing
- dynamodb - Database change events
- s3 - File upload processing
- user-migration - Import existing users
🌐 get_hosting_setup
Deployment and hosting configuration:
- Build settings
- Custom domains
- Environment variables
- CI/CD pipeline
🚀 Server-Side Rendering
get_ssr_setup
Provides Next.js App Router SSR configuration:
- nextjs-app-router - Complete Next.js setup
- client-config - Client-side Amplify configuration
- server-config - Server-side utilities
- auth-routes - Authentication components
- middleware - Auth middleware setup
- data-operations - Server-side data access
- social-providers - Social login configuration
🔧 Troubleshooting
get_troubleshooting
Solutions for common Amplify issues:
- configuration-errors - Missing config or NoCredentials
- cdk-toolkit - CDK bootstrap problems
- module-not-found - TypeScript module errors
- circular-dependencies - Stack dependency issues
🎯 get_amplify_implementation_checklist
NEW in v1.5.0 - Get comprehensive implementation checklist for any Amplify feature:
- auth - Authentication implementation checklist
- storage - Storage implementation checklist
- data - GraphQL/Data implementation checklist
- functions - Lambda implementation checklist
- general - General implementation checklist
This tool provides:
- ✅ Client-side setup requirements (Amplify.configure)
- ✅ Authorization mode decision trees
- ✅ Common pitfalls and solutions
- ✅ Complete working examples with proper authMode usage
📝 list_all_features
Shows all available Amplify features and tools
Usage Examples
In Claude, you can ask:
🆕 Implementation Checklists (Recommended First!)
- "Get the implementation checklist for Amplify data"
- "Show me the auth implementation checklist"
- "What's the checklist for storage setup?"
- "Give me the general Amplify checklist"
Authentication
- "Show me the basic Amplify Auth setup"
- "How do I add Google and Facebook login?"
- "Set up MFA with TOTP for my app"
- "Show me the sign-up flow code"
- "How do I manage user attributes?"
- "Add custom attributes like display_name"
- "Create admin and editor user groups"
- "Implement passwordless authentication"
Storage
- "Show me the basic Amplify Storage setup"
- "How do I configure file access paths?"
- "Set up multiple S3 buckets"
- "Add Lambda triggers for file uploads"
- "Show me file upload with progress tracking"
- "How to download files from S3?"
- "Display images with Storage Image component"
Functions
- "Show me basic Lambda function setup"
- "How do I add environment variables to functions?"
- "Set up scheduled Lambda functions"
- "Add Cognito triggers for user onboarding"
- "Process DynamoDB stream events"
- "How to use Python or Go for Lambda?"
- "Stream function logs in real-time"
Data
- "Create a GraphQL schema for a todo app"
- "Show me how to set up real-time subscriptions"
- "Configure owner-based authorization"
- "Integrate with AWS Bedrock for AI features"
Hosting
- "Set up hosting for my Next.js app"
- "Configure custom domains"
Server-Side Rendering
- "Show me Next.js App Router with Amplify"
- "How to configure server-side auth"
- "Create middleware for protected routes"
- "Server-side data fetching with cookies"
Troubleshooting
- "Fix Amplify.configure not found error"
- "Resolve CDKToolkit stack issues"
- "Fix circular dependency between stacks"
- "Handle module $amplify/env errors"
Contributing
To add more documentation:
- Edit
src/index.ts - Add new content to the
amplifyDocsobject - Create new tools if needed
- Build and test locally
- Submit PR
Publishing
npm run build
npm publish --access publicPart of the Chinchilla Enterprises MCP suite
