S3 YAML MCP Server
About
# S3 YAML MCP Server A Model Context Protocol (MCP) server that connects to AWS S3 to provide access to YAML files containing Swagger/OpenAPI documentation. Designed for seamless integration with VS Code and GitHub Copilot. ## 🎯 What is MCP? Model Context Protocol (MCP) is an open protocol that standardizes how…
Explore
- 🔗 S3 Integration: Connect to any S3-compatible storage service
- 📁 YAML File Discovery: Automatically list and discover YAML/YML files
- 📖 Content Access: Read and provide YAML content to AI assistants
- 🔍 Advanced Search: Search for files and specific API endpoint details
- 🚀 VS Code Native: Built-in integration with VS Code and GitHub Copilot
- 🔒 Secure Authentication: Uses AWS CLI credentials or IAM roles
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
S3 YAML MCP ServerCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
- AWS credentials configured (via AWS CLI, IAM roles, or environment variables)
- S3 bucket containing YAML files
- VS Code with GitHub Copilot extension
curl -fsSL https://raw.githubusercontent.com/ander-castiblanco-stori/s3-mcp-server/main/install.sh | bash
This will:
- Download the latest binary for your platform
- Install it to /usr/local/bin
- Set up VS Code configuration files
go install github.com/ander-castiblanco-stori/s3-mcp-server@latest
docker run -it --rm \
-e S3_BUCKET=your-bucket \
-e S3_REGION=us-east-1 \
-e AWS_ACCESS_KEY_ID=your-key \
-e AWS_SECRET_ACCESS_KEY=your-secret \
ghcr.io/ander-castiblanco-stori/s3-mcp-server:latest
cat > .env << 'EOF'
S3_BUCKET=your-api-docs-bucket
S3_REGION=us-east-1
EOF
3. Set up VS Code (if not done by installer):
mkdir -p .vscode
cat > .vscode/mcp.json << 'EOF'
{
"mcpServers": {
"s3YamlDocs": {
"command": "s3-mcp-server",
"args": [],
"env": {
"S3_BUCKET": "your-bucket-name",
"S3_REGION": "us-east-1"
}
}
}
}
EOF
4. Test the connection:
./test-vscode-integration.sh
4. Open in VS Code:
code .
5. Start using with GitHub Copilot:
- Open GitHub Copilot Chat (Cmd+Shift+I on macOS)
- Type: @s3YamlDocs list all YAML files in my bucket
Create a .env file based on .env.example:
The server supports multiple authentication methods:
1. AWS CLI credentials (recommended): aws configure
2. IAM roles (for EC2/Lambda deployments)
3. Environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
| Method | Command | Use Case |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------ |
| One-line install | curl -fsSL https://raw.githubusercontent.com/ander-castiblanco-stori/s3-mcp-server/main/install.sh \| bash | Production use across projects |
| Go install | go install github.com/ander-castiblanco-stori/s3-mcp-server@latest | Go developers |
| Binary download | Download from releases | Manual installation |
| Docker | docker pull ghcr.io/ander-castiblanco-stori/s3-mcp-server:latest | Container environments |
| Clone & build | git clone && make build | Development |
- search_yaml_files: Search for YAML files by name pattern
- list_yaml_files: List all YAML files with optional prefix filtering
- get_endpoint_details: Get detailed information about specific API endpoints including request/response schemas
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"s3 yaml mcp server": {
"s3-mcp-server-ander-castiblanco-stori": {
"command": "docker",
"args": [
"pull",
"ghcr.io/ander-castiblanco-stori/s3-mcp-server:latest"
]
}
}
}
}McpServers
{
"s3-mcp-server-ander-castiblanco-stori": {
"command": "docker",
"args": [
"pull",
"ghcr.io/ander-castiblanco-stori/s3-mcp-server:latest"
]
}
}A Model Context Protocol (MCP) server that connects to AWS S3 to provide access to YAML files containing Swagger/OpenAPI documentation. Designed for seamless integration with VS Code and GitHub Copilot.
🎯 What is MCP?
Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It enables AI assistants to securely access data sources and tools.
✨ Features
- 🔗 S3 Integration: Connect to any S3-compatible storage service
- 📁 YAML File Discovery: Automatically list and discover YAML/YML files
- 📖 Content Access: Read and provide YAML content to AI assistants
- 🔍 Advanced Search: Search for files and specific API endpoint details
- 🚀 VS Code Native: Built-in integration with VS Code and GitHub Copilot
- 🔒 Secure Authentication: Uses AWS CLI credentials or IAM roles
🚀 Installation
Method 1: One-Line Install (Recommended)
curl -fsSL https://raw.githubusercontent.com/ander-castiblanco-stori/s3-mcp-server/main/install.sh | bash
This will:
- Download the latest binary for your platform
- Install it to /usr/local/bin
- Set up VS Code configuration files
Method 2: Go Install
go install github.com/ander-castiblanco-stori/s3-mcp-server@latest
Method 3: Download Binary
Visit the releases page and download the binary for your platform.
Method 4: Docker
docker pull ghcr.io/ander-castiblanco-stori/s3-mcp-server:latest
🐳 Docker Usage
Quick Start with Docker
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
