MCP Bundler

🚀 MCP Packaging Service

This is a microservice designed to package code from GitHub repositories and prepare it for deployment. It supports either directly returning the packaged code or uploading the code to Google Cloud Storage.

🚀 Quick Start

# Install dependencies
pnpm install

# Start the development server
pnpm run dev

# Access the API documentation
open http://localhost:8080/docs

📚 Documentation

When the service is running, you can access the interactive API documentation at the /docs path.

🔧 Technical Details

Core Endpoints

Home Route

GET /

Returns a static HTML page displaying information about the service.

Health Check

GET /health

Returns a simple status check to verify if the service is running properly.

V1 Bundler (Legacy Version)

GET /bundler?url=<github_url>&commit=<commit_hash>&format=<mjs|cjs>

Parameters:

• url (Required): GitHub repository URL
• commit (Optional): Specific commit hash (default is the latest)
• format (Optional): Output format - mjs (default) or cjs

Response:

{
  "data": "<Packaged code as a string>"
}

V2 Bundler (with Optional GCP Upload)

GET /v2/bundler?url=<github_url>&commit=<commit_hash>&mcpId=<your_mcp_id>

Parameters:

• url (Required): GitHub repository URL
• commit (Optional): Specific commit hash (default is the latest)
• mcpId (Optional): Unique server packaging identifier (automatically generated if not provided)

Response with GCP Upload Enabled:

{
  "success": true,
  "gcp_upload": {
    "bucket": "your-bucket-name",
    "path": "your-mcp-id/commit-hash/",
    "files": [
      "bundle-commit-hash.tar.gz"
    ]
  }
}

Response with GCP Upload Disabled:

{
  "success": true,
  "data": "<Packaged code as a string>"
}

🔧 GCP Integration (Optional)

The V2 bundler can upload the packaged code to Google Cloud Storage for use by other services or directly return the packaged code.

Disable GCP Upload

If you want to disable GCP upload and directly obtain the packaged code in the API response, set:

DISABLE_GCP_INTEGRATION=true

in your environment or .env file. When GCP integration is disabled:

1. The packaged code is directly returned in the API response.
2. An archived copy of the packaged code is saved to the bundled directory in the project root.
3. The archived file name is in the format bundle-[commit hash].tar.gz.

Set GCP Credentials

If you want to use GCP upload, you need to provide your Google Cloud Platform credentials:

Add your service account key JSON directly to the .env file:

GOOGLE_CLOUD_KEY=your-service-account-key.json

Important Note

⚠️ Important Note

If you disable GCP integration, you need to handle the storage of the packaged files yourself.

⚠️ Important Note

Ensure that your service account has sufficient permissions to upload files to Google Cloud Storage.

🚀 Deployment Instructions

Dependencies

Before you start, make sure to install the following dependencies:

npm install @mcp/bundler

Environment Variables

Set the following environment variables:

SENTRY_INGEST_URL=your-sentry-ingest-url

Important Note

⚠️ Important Note

The bundler supports the following formats: tar.gz, zip, tgz.

⚠️ Important Note

Supported platforms include: Linux, Windows, macOS.

⚠️ Important Note

Ensure that your GitHub token has permission to read the repository content.

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.