@mastra/mcp-docs-server 0.0.0-commonjs-20250414101718

package/.docs/raw/reference/deployer/cloudflare.mdx

@@ -0,0 +1,207 @@
+---
+title: "Cloudflare Deployer"
+description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
+---
+
+# CloudflareDeployer
+
+The CloudflareDeployer deploys Mastra applications to Cloudflare Workers, handling configuration, environment variables, and route management. It extends the abstract Deployer class to provide Cloudflare-specific deployment functionality.
+
+## Usage Example
+
+```typescript
+import { Mastra } from '@mastra/core';
+import { CloudflareDeployer } from '@mastra/deployer-cloudflare';
+
+const mastra = new Mastra({
+  deployer: new CloudflareDeployer({
+    scope: 'your-account-id',
+    projectName: 'your-project-name',
+    routes: [
+      {
+        pattern: 'example.com/*',
+        zone_name: 'example.com',
+        custom_domain: true,
+      },
+    ],
+    workerNamespace: 'your-namespace',
+    auth: {
+      apiToken: 'your-api-token',
+      apiEmail: 'your-email',
+    },
+  }),
+  // ... other Mastra configuration options
+});
+```
+
+## Parameters
+
+### Constructor Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "scope",
+      type: "string",
+      description: "Your Cloudflare account ID.",
+      isOptional: false,
+    },
+    {
+      name: "projectName",
+      type: "string",
+      description: "Name of your worker project.",
+      isOptional: true,
+      defaultValue: "'mastra'",
+    },
+    {
+      name: "routes",
+      type: "CFRoute[]",
+      description: "Array of route configurations for your worker.",
+      isOptional: true,
+    },
+    {
+      name: "workerNamespace",
+      type: "string",
+      description: "Namespace for your worker.",
+      isOptional: true,
+    },
+    {
+      name: "env",
+      type: "Record<string, any>",
+      description: "Environment variables to be included in the worker configuration.",
+      isOptional: true,
+    },
+    {
+      name: "auth",
+      type: "object",
+      description: "Cloudflare authentication details.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+### auth Object
+
+<PropertiesTable
+  content={[
+    {
+      name: "apiToken",
+      type: "string",
+      description: "Your Cloudflare API token.",
+      isOptional: false,
+    },
+    {
+      name: "apiEmail",
+      type: "string",
+      description: "Your Cloudflare account email.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+### CFRoute Object
+
+<PropertiesTable
+  content={[
+    {
+      name: "pattern",
+      type: "string",
+      description: "URL pattern to match (e.g., 'example.com/*').",
+      isOptional: false,
+    },
+    {
+      name: "zone_name",
+      type: "string",
+      description: "Domain zone name.",
+      isOptional: false,
+    },
+    {
+      name: "custom_domain",
+      type: "boolean",
+      description: "Whether to use a custom domain.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+  ]}
+/>
+
+### Environment Variables
+
+The CloudflareDeployer handles environment variables from multiple sources:
+
+1. **Environment Files**: Variables from `.env.production` and `.env` files.
+2. **Configuration**: Variables passed through the `env` parameter.
+
+
+## Build Mastra Project
+
+To build your Mastra project for cloudflare deployment:
+
+```bash
+npx mastra build
+```
+
+The build process generates the following output structure in the `.mastra/output` directory:
+
+```
+.mastra/output/
+├── index.mjs        # Main worker entry point
+├── wrangler.json    # Cloudflare Worker configuration
+└── assets/          # Static assets and dependencies
+```
+
+### Wrangler Configuration
+
+The CloudflareDeployer automatically generates a `wrangler.json` configuration file with the following settings:
+
+```json
+{
+  "name": "your-project-name",
+  "main": "./output/index.mjs",
+  "compatibility_date": "2024-12-02",
+  "compatibility_flags": ["nodejs_compat"],
+  "observability": {
+    "logs": {
+      "enabled": true
+    }
+  },
+  "vars": {
+    // Environment variables from .env files and configuration
+  },
+  "routes": [
+    // Route configurations if specified
+  ]
+}
+```
+
+### Route Configuration
+
+Routes can be configured to direct traffic to your worker based on URL patterns and domains:
+
+```typescript
+const routes = [
+  {
+    pattern: 'api.example.com/*',
+    zone_name: 'example.com',
+    custom_domain: true,
+  },
+  {
+    pattern: 'example.com/api/*',
+    zone_name: 'example.com',
+  },
+];
+```
+
+
+## Deployment Options
+
+After building, you can deploy your Mastra application `.mastra/output`  to Cloudflare Workers using any of these methods:
+
+1. **Wrangler CLI**: Deploy directly using Cloudflare's official CLI tool
+
+2. **Cloudflare Dashboard**: Upload the build output manually through the Cloudflare dashboard
+
+
+## Platform Documentation
+
+- [Cloudflare Workers](https://developers.cloudflare.com/workers/)

package/.docs/raw/reference/deployer/deployer.mdx

@@ -0,0 +1,159 @@
+---
+title: "Mastra Deployer"
+description: Documentation for the Deployer abstract class, which handles packaging and deployment of Mastra applications.
+---
+
+# Deployer
+
+The Deployer handles the deployment of Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
+
+## Usage Example
+
+```typescript
+import { Deployer } from "@mastra/deployer";
+
+// Create a custom deployer by extending the abstract Deployer class
+class CustomDeployer extends Deployer {
+  constructor() {
+    super({ name: 'custom-deployer' });
+  }
+
+  // Implement the abstract deploy method
+  async deploy(outputDirectory: string): Promise<void> {
+    // Prepare the output directory
+    await this.prepare(outputDirectory);
+    
+    // Bundle the application
+    await this._bundle('server.ts', 'mastra.ts', outputDirectory);
+    
+    // Custom deployment logic
+    // ...
+  }
+}
+```
+
+## Parameters
+
+### Constructor Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "args",
+      type: "object",
+      description: "Configuration options for the Deployer.",
+      isOptional: false,
+    },
+    {
+      name: "args.name",
+      type: "string",
+      description: "A unique name for the deployer instance.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+### deploy Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "outputDirectory",
+      type: "string",
+      description: "The directory where the bundled and deployment-ready application will be output.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+## Methods
+
+<PropertiesTable
+  content={[
+    {
+      name: "getEnvFiles",
+      type: "() => Promise<string[]>",
+      description: "Returns a list of environment files to be used during deployment. By default, it looks for '.env.production' and '.env' files.",
+    },
+    {
+      name: "deploy",
+      type: "(outputDirectory: string) => Promise<void>",
+      description: "Abstract method that must be implemented by subclasses. Handles the deployment process to the specified output directory.",
+    },
+  ]}
+/>
+
+## Inherited Methods from Bundler
+
+The Deployer class inherits the following key methods from the Bundler class:
+
+<PropertiesTable
+  content={[
+    {
+      name: "prepare",
+      type: "(outputDirectory: string) => Promise<void>",
+      description: "Prepares the output directory by cleaning it and creating necessary subdirectories.",
+    },
+    {
+      name: "writeInstrumentationFile",
+      type: "(outputDirectory: string) => Promise<void>",
+      description: "Writes an instrumentation file to the output directory for telemetry purposes.",
+    },
+    {
+      name: "writePackageJson",
+      type: "(outputDirectory: string, dependencies: Map<string, string>) => Promise<void>",
+      description: "Generates a package.json file in the output directory with the specified dependencies.",
+    },
+    {
+      name: "_bundle",
+      type: "(serverFile: string, mastraEntryFile: string, outputDirectory: string, bundleLocation?: string) => Promise<void>",
+      description: "Bundles the application using the specified server and Mastra entry files.",
+    },
+  ]}
+/>
+
+## Core Concepts
+
+### Deployment Lifecycle
+
+The Deployer abstract class implements a structured deployment lifecycle:
+
+1. **Initialization**: The deployer is initialized with a name and creates a Deps instance for dependency management.
+2. **Environment Setup**: The `getEnvFiles` method identifies environment files (.env.production, .env) to be used during deployment.
+3. **Preparation**: The `prepare` method (inherited from Bundler) cleans the output directory and creates necessary subdirectories.
+4. **Bundling**: The `_bundle` method (inherited from Bundler) packages the application code and its dependencies.
+5. **Deployment**: The abstract `deploy` method is implemented by subclasses to handle the actual deployment process.
+
+### Environment File Management
+
+The Deployer class includes built-in support for environment file management through the `getEnvFiles` method. This method:
+
+- Looks for environment files in a predefined order (.env.production, .env)
+- Uses the FileService to find the first existing file
+- Returns an array of found environment files
+- Returns an empty array if no environment files are found
+
+```typescript
+getEnvFiles(): Promise<string[]> {
+  const possibleFiles = ['.env.production', '.env.local', '.env'];
+
+  try {
+    const fileService = new FileService();
+    const envFile = fileService.getFirstExistingFile(possibleFiles);
+
+    return Promise.resolve([envFile]);
+  } catch {}
+
+  return Promise.resolve([]);
+}
+```
+
+### Bundling and Deployment Relationship
+
+The Deployer class extends the Bundler class, establishing a clear relationship between bundling and deployment:
+
+1. **Bundling as a Prerequisite**: Bundling is a prerequisite step for deployment, where the application code is packaged into a deployable format.
+2. **Shared Infrastructure**: Both bundling and deployment share common infrastructure like dependency management and file system operations.
+3. **Specialized Deployment Logic**: While bundling focuses on code packaging, deployment adds environment-specific logic for deploying the bundled code.
+4. **Extensibility**: The abstract `deploy` method allows for creating specialized deployers for different target environments.
+

package/.docs/raw/reference/deployer/netlify.mdx

@@ -0,0 +1,109 @@
+---
+title: "Netlify Deployer"
+description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
+---
+
+# NetlifyDeployer
+
+The NetlifyDeployer deploys Mastra applications to Netlify Functions, handling site creation, configuration, and deployment processes. It extends the abstract Deployer class to provide Netlify-specific deployment functionality.
+
+## Usage Example
+
+```typescript
+import { Mastra } from '@mastra/core';
+import { NetlifyDeployer } from '@mastra/deployer-netlify';
+
+const mastra = new Mastra({
+  deployer: new NetlifyDeployer({
+    scope: 'your-team-slug',
+    projectName: 'your-project-name',
+    token: 'your-netlify-token'
+  }),
+  // ... other Mastra configuration options
+});
+```
+
+## Parameters
+
+### Constructor Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "scope",
+      type: "string",
+      description: "Your Netlify team slug or ID.",
+      isOptional: false,
+    },
+    {
+      name: "projectName",
+      type: "string",
+      description: "Name of your Netlify site (will be created if it doesn't exist).",
+      isOptional: false,
+    },
+    {
+      name: "token",
+      type: "string",
+      description: "Your Netlify authentication token.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+
+### Environment Variables
+
+The NetlifyDeployer handles environment variables from multiple sources:
+
+1. **Environment Files**: Variables from `.env.production` and `.env` files.
+2. **Configuration**: Variables passed through the Mastra configuration.
+3. **Netlify Dashboard**: Variables can also be managed through Netlify's web interface.
+
+
+## Build Mastra Project
+
+To build your Mastra project for Netlify deployment:
+
+```bash
+npx mastra build
+```
+
+The build process generates the following output structure in the `.mastra/output` directory:
+
+```
+.mastra/output/
+├── netlify/
+│   └── functions/
+│       └── api/
+│           └── index.mjs    # Application entry point
+└── netlify.toml             # Netlify configuration
+```
+
+### Netlify Configuration
+
+The NetlifyDeployer automatically generates a `netlify.toml` configuration file in `.mastra/output` with the following settings:
+
+```toml
+[functions]
+node_bundler = "esbuild"            
+directory = "netlify/functions"
+
+[[redirects]]
+force = true
+from = "/*"
+status = 200
+to = "/.netlify/functions/api/:splat"
+```
+
+## Deployment Options
+
+After building, you can deploy your Mastra application `.mastra/output` to Netlify using any of these methods:
+
+1. **Netlify CLI**: Deploy directly using Netlify's official CLI tool
+
+2. **Netlify Dashboard**: Connect your Git repository or drag-and-drop the build output through the Netlify dashboard
+
+
+## Platform Documentation
+
+- [Netlify](https://docs.netlify.com/)

package/.docs/raw/reference/deployer/vercel.mdx

@@ -0,0 +1,117 @@
+---
+title: "Vercel Deployer"
+description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
+---
+
+# VercelDeployer
+
+The VercelDeployer deploys Mastra applications to Vercel, handling configuration, environment variable synchronization, and deployment processes. It extends the abstract Deployer class to provide Vercel-specific deployment functionality.
+
+## Usage Example
+
+```typescript
+import { Mastra } from '@mastra/core';
+import { VercelDeployer } from '@mastra/deployer-vercel';
+
+const mastra = new Mastra({
+  deployer: new VercelDeployer({
+    teamSlug: 'your-team-slug',
+    projectName: 'your-project-name',
+    token: 'your-vercel-token'
+  }),
+  // ... other Mastra configuration options
+});
+```
+
+## Parameters
+
+### Constructor Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "teamSlug",
+      type: "string",
+      description: "Your Vercel team slug",
+      isOptional: false,
+    },
+    {
+      name: "projectName",
+      type: "string",
+      description: "Name of your Vercel project (will be created if it doesn't exist).",
+      isOptional: false,
+    },
+    {
+      name: "token",
+      type: "string",
+      description: "Your Vercel authentication token.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+
+### Environment Variables
+
+The VercelDeployer handles environment variables from multiple sources:
+
+1. **Environment Files**: Variables from `.env.production` and `.env` files.
+2. **Configuration**: Variables passed through the Mastra configuration.
+3. **Vercel Dashboard**: Variables can also be managed through Vercel's web interface.
+
+The deployer automatically synchronizes environment variables between your local development environment and Vercel's environment variable system, ensuring consistency across all deployment environments (production, preview, and development).
+
+## Build Mastra Project
+
+To build your Mastra project for Vercel deployment:
+
+```bash
+npx mastra build
+```
+
+The build process generates the following output structure in the `.mastra/output` directory:
+
+```
+.mastra/output/
+├── vercel.json     # Vercel configuration
+└── index.mjs       # Application entry point
+```
+
+### Vercel Configuration
+
+The VercelDeployer automatically generates a `vercel.json` configuration file in `.mastra/output` with the following settings:
+
+```json
+{
+  "version": 2,
+  "installCommand": "npm install --omit=dev",
+  "builds": [
+    {
+      "src": "index.mjs",
+      "use": "@vercel/node",
+      "config": {
+        "includeFiles": ["**"]
+      }
+    }
+  ],
+  "routes": [
+    {
+      "src": "/(.*)",
+      "dest": "index.mjs"
+    }
+  ]
+}
+```
+
+## Deployment Options
+
+After building, you can deploy your Mastra application `.mastra/output` to Vercel using any of these methods:
+
+1. **Vercel CLI**: Deploy directly using Vercel's official CLI tool
+
+2. **Vercel Dashboard**: Connect your Git repository or drag-and-drop the build output through the Vercel dashboard
+
+
+## Platform Documentation
+
+- [Vercel](https://vercel.com/docs)