ocean
ocean copied to clipboard
[Docs] AWS Documentation MCP with automated team setup
User description
feat: add AWS Documentation MCP integration with automated team setup
• Add one-command setup script (scripts/setup-aws-docs-mcp.sh) that:
- Installs uv package manager and Python 3.10+ if needed
- Installs AWS Documentation MCP server via
uv tool install - Intelligently merges with existing Cursor MCP configurations
- Preserves existing MCP servers (GitHub, graphiti-memory, etc.)
- Auto-configures with pre-approved AWS documentation tools
• Add Cursor rules (aws-documentation-mcp.mdc) for AWS development:
- Best practices for using AWS MCP in Ocean integrations
- Guidance on citing sources and using current documentation
- Examples for S3, Lambda, VPC, and other AWS services
- Integration patterns with existing Ocean development workflow
• Add comprehensive team documentation (AWS_DOCS_MCP_SETUP.md):
- Quick start guide with usage examples
- Troubleshooting instructions and configuration details
- Advanced usage patterns for contextual AWS queries
- Cross-platform support documentation
• Add verification script (scripts/test-aws-docs-mcp.sh):
- Tests all setup components (uv, Python, MCP server, config)
- Validates Cursor configuration and rule files
- Provides detailed pass/fail reporting with next steps
Benefits:
- Team members get AWS docs directly in Cursor chat with @aws-docs
- Zero manual configuration required per developer
- Automatic source citation and current best practices
- Seamless integration with existing Ocean development patterns
- Supports both permanent installation and temporary uvx usage
Enables @aws-docs queries in Cursor for real-time AWS documentation access with automatic source citation and Ocean integration patterns.
Description
What - A complete automated setup system that integrates AWS Documentation directly into Cursor IDE through Model Context Protocol (MCP). Developers can query AWS documentation in real-time using @aws-docs without leaving their development environment. Components:
- One-command setup script with cross-platform support
- Intelligent MCP configuration that preserves existing servers
- Cursor rules for AWS development best practices
- Team documentation and verification tools
Why - Why - Solving Development Friction Problems Solved:
- Context Switching: Developers constantly switch between IDE and browser for AWS docs
- Inconsistent Information: Teams use different or outdated AWS documentation sources
- Integration Gaps: No standardized AWS documentation workflow for Ocean development Value Delivered:
- Faster Development: No more browser switching - AWS docs directly in chat
- Consistent Practices: Entire team uses current AWS documentation with automatic citations
- Better Code Quality: Real-time access to current AWS best practices and examples
How - Implementation & Usage Team Setup (One-time):
./scripts/setup-aws-docs-mcp.sh # Installs and configures everything
./scripts/test-aws-docs-mcp.sh # Verifies setup works correctly
Daily Develpmnt Usage:
In Cursor chat:
@aws-docs "S3 event notifications for Lambda - get config and IAM permissions"
@aws-docs "VPC endpoint setup for private S3 access with security best practices"
@aws-docs "Lambda memory and timeout recommendations for high-throughput processing"
Technical Features:
- Auto-approves AWS documentation tools for seamless usage
- Cross-platform support (macOS, Linux, Windows)
- Fallback strategies ensure reliability across different environments
Type of change
Please leave one option from the following and delete the rest:
- [x] New feature (non-breaking change which adds functionality)
All tests should be run against the port production environment(using a testing org).
Core testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Resync finishes successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Scheduled resync able to abort existing resync and start a new one
- [ ] Tested with at least 2 integrations from scratch
- [ ] Tested with Kafka and Polling event listeners
- [ ] Tested deletion of entities that don't pass the selector
Integration testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Resync finishes successfully
- [ ] If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the
examplesfolder in the integration directory. - [ ] If resource kind is updated, run the integration with the example data and check if the expected result is achieved
- [ ] If new resource kind is added or updated, validate that live-events for that resource are working as expected
- [x] Docs PR link here
Preflight checklist
- [ ] Handled rate limiting
- [ ] Handled pagination
- [ ] Implemented the code in async
- [ ] Support Multi account
Screenshots
Include screenshots from your environment showing how the resources of the integration will look.
https://github.com/user-attachments/assets/081f3703-bfcd-4854-a78c-1ea94a19948e
API Documentation
Provide links to the API documentation used for this integration.
PR Type
Enhancement
Description
-
Add automated AWS Documentation MCP integration for Cursor IDE
-
Provide one-command setup script with cross-platform support
-
Include comprehensive team documentation and usage guidelines
-
Add verification script for testing MCP installation
Changes diagram
flowchart LR
A["Setup Script"] --> B["Install Dependencies"]
B --> C["Configure Cursor MCP"]
C --> D["Add Usage Rules"]
D --> E["Generate Documentation"]
E --> F["Team Ready"]
B --> B1["uv package manager"]
B --> B2["Python 3.10+"]
B --> B3["AWS MCP Server"]
C --> C1["MCP Configuration"]
C --> C2["Auto-approve Tools"]
D --> D1["Cursor Rules"]
D --> D2["Best Practices"]
Changes walkthrough 📝
| Relevant files | |||||
|---|---|---|---|---|---|
| Enhancement |
| ||||
| Tests |
| ||||
| Documentation |
|
Need help?
Type /help how to ...in the comments thread for any questions about Qodo Merge usage.Check out the documentation for more information.