Serverless Web MCP Server

🚀 Serverless Web MCP Server

This project implements the application of the Model Context Protocol (MCP) in AWS serverless deployment, supporting the deployment of backend, frontend, and full-stack applications. Through this implementation, developers can easily deploy applications to the AWS cloud environment without managing underlying servers.

🚀 Quick Start

Prerequisites

• AWS account
• AWS SAM CLI installed
• Node.js and npm installed

Deployment Steps

1. Clone the repository:

git clone https://github.com/your-repo/serverless-web-mcp-server.git
cd serverless-web-mcp-server

2. Install dependencies:

npm install

3. Deploy the application:

npm run deploy

✨ Features

Core Components

• Protocol Implementation: Implements the complete MCP protocol specification, including resource management and tool invocation.
• Functional Features:
  • Supports multiple deployment types (backend, frontend, full-stack).
  • Provides database configuration support.
  • Supports custom environment variables.
  • Integrates AWS SAM CLI.

Architecture Design

/
├── src/
│   ├── mcp/              # MCP protocol implementation directory
│   │   ├── tools/        # Tool implementation module
│   │   │   └── index.ts  # Tool registration file
│   │   ├── resources/    # Resource implementation module
│   │   │   └── index.ts  # Resource registration file
│   │   └── server.ts     # MCP server main program
│   ├── deployment/       # Deployment service module
│   ├── cli/              # Command-line tool directory
│   └── index.ts          # Application entry file
├── templates/            # Deployment template folder
├── examples/             # Example application cases
├── docs/                 # Documentation materials
├── config.json           # Server configuration file
├── DESIGN.md             # Detailed design document
└── README.md             # Project description file

📦 Installation

Project Structure

• Code Section: src/

  • mcp/: Specific implementation of the MCP protocol, including the registration and management of tools and resources.
  • deployment/: Responsible for handling the deployment logic of applications.
  • cli/: Provides command-line interface functionality.
  • index.ts: The main entry file of the project.

• Static Resources: templates/

  • Template files required for deployment, used to generate cloud resource configurations.

• Example Applications: examples/

  • Provides example code for various application scenarios, facilitating users to quickly get started.

💻 Usage Examples

Backend Deployment

{
  "deploymentType": "backend",
  "projectName": "my-api",
  "projectRoot": "/path/to/project",
  "region": "us-east-1",
  "backendConfiguration": {
    "builtArtifactsPath": "backend/dist",
    "runtime": "nodejs18.x",
    "startupScript": "bootstrap",
    "memorySize": 512,
    "timeout": 30,
    "environment": {
      "NODE_ENV": "production"
    },
    "databaseConfiguration": {
      "tableName": "Users",
      "attributeDefinitions": [
        { "name": "id", "type": "S" }
      ],
      "keySchema": [
        { "name": "id", "type": "HASH" }
      ]
    }
  }
}

Frontend Deployment

{
  "deploymentType": "frontend",
  "projectName": "my-website",
  "projectRoot": "/path/to/project",
  "region": "us-east-1",
  "frontendConfiguration": {
    "builtAssetsPath": "frontend/build",
    "indexDocument": "index.html"
  }
}

Full-stack Deployment

{
  "deploymentType": "fullstack",
  "projectName": "my-fullstack-app",
  "projectRoot": "/path/to/project",
  "region": "us-east-1",
  "backendConfiguration": {
    "builtArtifactsPath": "backend/dist",
    "runtime": "nodejs18.x",
    "environment": {
      "NODE_ENV": "production"
    }
  },
  "frontendConfiguration": {
    "builtAssetsPath": "frontend/build",
    "indexDocument": "index.html"
  }
}

MCP Protocol Implementation

// src/mcp/server.ts
import { MCP } from './mcp';

const server = new MCP();
server.start();

Tool Invocation Example

# Deploy the backend service
npm run deploy -- --type backend

# Deploy the frontend service
npm run deploy -- --type frontend

📚 Documentation

For detailed design documents and usage instructions, please refer to the files in the docs/ directory.

🔧 Technical Details

The detailed design of the project can be found in the DESIGN.md file.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

💪 Contribution Guidelines

Community contributions are welcome! For the contribution process, please refer to CONTRIBUTING.md.