feat: add Docker support to generated projects (#13)

* feat: add Docker support to generated projects

* fixed lint error

* bumped version to 0.4.0

Author: IBJunior

CLAUDE.md

@@ -15,6 +15,11 @@ create-mcp-server/
 │       │   ├── gitignore.ts        # .gitignore template
 │       │   ├── env.example.ts      # .env.example template
 │       │   └── templates.test.ts   # Tests for common templates
+│       ├── deployment/             # Deployment configuration templates
+│       │   ├── dockerfile.ts       # Dockerfile template
+│       │   ├── dockerignore.ts     # .dockerignore template
+│       │   ├── index.ts            # Barrel exports
+│       │   └── templates.test.ts   # Tests for deployment templates
 │       ├── sdk/                    # Official MCP SDK templates
 │       │   ├── stateless/          # Stateless HTTP template
 │       │   │   ├── server.ts       # MCP server definition template
@@ -141,9 +146,29 @@ Generated project structure (same for all templates, +auth.ts when OAuth enabled
 │   ├── server.ts     # MCP server with tools/prompts/resources
 │   ├── index.ts      # Server startup configuration
 │   └── auth.ts       # OAuth middleware (SDK stateful + OAuth only)
+├── Dockerfile        # Multi-stage Docker build
+├── .dockerignore     # Docker ignore file
 ├── package.json
 ├── tsconfig.json
 ├── .gitignore
 ├── .env.example
 └── README.md
 ```
+
+## Deployment
+
+All generated projects include deployment configuration by default:
+
+### Dockerfile
+
+Multi-stage build for production:
+- Uses Node 20 Alpine as base image
+- Builds TypeScript in builder stage
+- Copies only production dependencies and dist to final image
+- Exposes port 3000
+
+### Health Check Endpoint
+
+All templates include a `GET /health` endpoint:
+- SDK templates: Express route added in `index.ts`
+- FastMCP: Built-in health check support (enabled by default with httpStream transport)

README.md

@@ -15,6 +15,7 @@ npx @agentailor/create-mcp-server
 - **Optional OAuth** — OIDC-compliant authentication (SDK only) ([setup guide](docs/oauth-setup.md))
 - **Package manager choice** — npm, pnpm, or yarn
 - **TypeScript ready** — ready to customize
+- **Docker ready** — production Dockerfile included
 - **MCP Inspector** — built-in debugging with `npm run inspect`
 
 ## Frameworks
@@ -67,6 +68,7 @@ my-mcp-server/
 │   ├── server.ts     # MCP server (tools, prompts, resources)
 │   ├── index.ts      # Express app and transport setup
 │   └── auth.ts       # OAuth middleware (if enabled)
+├── Dockerfile        # Production-ready Docker build
 ├── package.json
 ├── tsconfig.json
 ├── .gitignore

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentailor/create-mcp-server",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Create a new MCP (Model Context Protocol) server project",
   "type": "module",
   "bin": {

package.json

@@ -30,6 +30,7 @@ import {
   getIndexTemplate as getFastMCPIndexTemplate,
   getReadmeTemplate as getFastMCPReadmeTemplate,
 } from './templates/fastmcp/index.js';
+import { getDockerfileTemplate, getDockerignoreTemplate } from './templates/deployment/index.js';
 
 type TemplateType = 'stateless' | 'stateful';
 
@@ -251,6 +252,12 @@ async function main() {
       writeFile(join(projectPath, '.env.example'), getEnvExampleTemplate(templateOptions))
     );
 
+    // Deployment files for all templates
+    filesToWrite.push(
+      writeFile(join(projectPath, 'Dockerfile'), getDockerfileTemplate(templateOptions)),
+      writeFile(join(projectPath, '.dockerignore'), getDockerignoreTemplate())
+    );
+
     // Write all template files
     await Promise.all(filesToWrite);
 

src/index.ts

@@ -0,0 +1,77 @@
+import type { BaseTemplateOptions, PackageManager } from '../common/types.js';
+
+interface PackageManagerDockerConfig {
+  lockFile: string;
+  install: string;
+  installProd: string;
+  build: string;
+  setup?: string;
+}
+
+const packageManagerConfigs: Record<PackageManager, PackageManagerDockerConfig> = {
+  npm: {
+    lockFile: 'package-lock.json',
+    install: 'npm ci',
+    installProd: 'npm ci --omit=dev',
+    build: 'npm run build',
+  },
+  pnpm: {
+    lockFile: 'pnpm-lock.yaml',
+    install: 'pnpm install --frozen-lockfile',
+    installProd: 'pnpm install --frozen-lockfile --prod',
+    build: 'pnpm run build',
+    setup: 'RUN corepack enable && corepack prepare pnpm@latest --activate',
+  },
+  yarn: {
+    lockFile: 'yarn.lock',
+    install: 'yarn install --frozen-lockfile',
+    installProd: 'yarn install --frozen-lockfile --production',
+    build: 'yarn build',
+    setup: 'RUN corepack enable',
+  },
+};
+
+export function getDockerfileTemplate(options?: BaseTemplateOptions): string {
+  const packageManager = options?.packageManager ?? 'npm';
+  const config = packageManagerConfigs[packageManager];
+
+  const setupStep = config.setup ? `\n${config.setup}\n` : '';
+
+  return `# Multi-stage build for production
+FROM node:20-alpine AS builder
+
+WORKDIR /app
+${setupStep}
+# Copy package files
+COPY package.json ${config.lockFile} ./
+
+# Install all dependencies (including dev)
+RUN ${config.install}
+
+# Copy source code
+COPY . .
+
+# Build the application
+RUN ${config.build}
+
+# Production stage
+FROM node:20-alpine AS production
+
+WORKDIR /app
+${setupStep}
+# Copy package files
+COPY package.json ${config.lockFile} ./
+
+# Install production dependencies only
+RUN ${config.installProd}
+
+# Copy built application from builder stage
+COPY --from=builder /app/dist ./dist
+
+# Expose the port the app runs on
+EXPOSE 3000
+
+# Start the application
+CMD ["node", "dist/index.js"]
+`;
+}

src/templates/deployment/dockerfile.ts

@@ -0,0 +1,37 @@
+export function getDockerignoreTemplate(): string {
+  return `# Dependencies
+node_modules/
+
+# Build output (rebuilt in container)
+dist/
+
+# Git
+.git/
+.gitignore
+
+# Environment files (should be set in container)
+.env
+.env.*
+
+# Documentation
+*.md
+
+# IDE
+.vscode/
+.idea/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+npm-debug.log*
+
+# Test files
+*.test.ts
+*.spec.ts
+__tests__/
+coverage/
+`;
+}

src/templates/deployment/dockerignore.ts

@@ -0,0 +1,2 @@
+export { getDockerfileTemplate } from './dockerfile.js';
+export { getDockerignoreTemplate } from './dockerignore.js';

src/templates/deployment/index.ts

@@ -0,0 +1,132 @@
+import { describe, it, expect } from 'vitest';
+import { getDockerfileTemplate } from './dockerfile.js';
+import { getDockerignoreTemplate } from './dockerignore.js';
+
+describe('deployment templates', () => {
+  describe('getDockerfileTemplate', () => {
+    it('should use multi-stage build', () => {
+      const template = getDockerfileTemplate();
+      expect(template).toContain('AS builder');
+      expect(template).toContain('AS production');
+    });
+
+    it('should use Node 20 Alpine', () => {
+      const template = getDockerfileTemplate();
+      expect(template).toContain('FROM node:20-alpine');
+    });
+
+    it('should copy dist folder from builder', () => {
+      const template = getDockerfileTemplate();
+      expect(template).toContain('COPY --from=builder /app/dist ./dist');
+    });
+
+    it('should expose port 3000', () => {
+      const template = getDockerfileTemplate();
+      expect(template).toContain('EXPOSE 3000');
+    });
+
+    it('should run node dist/index.js', () => {
+      const template = getDockerfileTemplate();
+      expect(template).toContain('CMD ["node", "dist/index.js"]');
+    });
+
+    describe('npm (default)', () => {
+      it('should use npm ci for install', () => {
+        const template = getDockerfileTemplate();
+        expect(template).toContain('RUN npm ci');
+      });
+
+      it('should use npm ci --omit=dev for production', () => {
+        const template = getDockerfileTemplate();
+        expect(template).toContain('npm ci --omit=dev');
+      });
+
+      it('should copy package-lock.json', () => {
+        const template = getDockerfileTemplate();
+        expect(template).toContain('COPY package.json package-lock.json');
+      });
+
+      it('should use npm run build', () => {
+        const template = getDockerfileTemplate();
+        expect(template).toContain('RUN npm run build');
+      });
+    });
+
+    describe('pnpm', () => {
+      it('should use pnpm install --frozen-lockfile', () => {
+        const template = getDockerfileTemplate({ packageManager: 'pnpm' });
+        expect(template).toContain('RUN pnpm install --frozen-lockfile');
+      });
+
+      it('should use pnpm install --frozen-lockfile --prod for production', () => {
+        const template = getDockerfileTemplate({ packageManager: 'pnpm' });
+        expect(template).toContain('pnpm install --frozen-lockfile --prod');
+      });
+
+      it('should copy pnpm-lock.yaml', () => {
+        const template = getDockerfileTemplate({ packageManager: 'pnpm' });
+        expect(template).toContain('COPY package.json pnpm-lock.yaml');
+      });
+
+      it('should enable corepack for pnpm', () => {
+        const template = getDockerfileTemplate({ packageManager: 'pnpm' });
+        expect(template).toContain('corepack enable');
+        expect(template).toContain('corepack prepare pnpm');
+      });
+
+      it('should use pnpm run build', () => {
+        const template = getDockerfileTemplate({ packageManager: 'pnpm' });
+        expect(template).toContain('RUN pnpm run build');
+      });
+    });
+
+    describe('yarn', () => {
+      it('should use yarn install --frozen-lockfile', () => {
+        const template = getDockerfileTemplate({ packageManager: 'yarn' });
+        expect(template).toContain('RUN yarn install --frozen-lockfile');
+      });
+
+      it('should use yarn install --frozen-lockfile --production for production', () => {
+        const template = getDockerfileTemplate({ packageManager: 'yarn' });
+        expect(template).toContain('yarn install --frozen-lockfile --production');
+      });
+
+      it('should copy yarn.lock', () => {
+        const template = getDockerfileTemplate({ packageManager: 'yarn' });
+        expect(template).toContain('COPY package.json yarn.lock');
+      });
+
+      it('should enable corepack for yarn', () => {
+        const template = getDockerfileTemplate({ packageManager: 'yarn' });
+        expect(template).toContain('corepack enable');
+      });
+
+      it('should use yarn build', () => {
+        const template = getDockerfileTemplate({ packageManager: 'yarn' });
+        expect(template).toContain('RUN yarn build');
+      });
+    });
+  });
+
+  describe('getDockerignoreTemplate', () => {
+    it('should ignore node_modules', () => {
+      const template = getDockerignoreTemplate();
+      expect(template).toContain('node_modules/');
+    });
+
+    it('should ignore dist folder', () => {
+      const template = getDockerignoreTemplate();
+      expect(template).toContain('dist/');
+    });
+
+    it('should ignore .env files', () => {
+      const template = getDockerignoreTemplate();
+      expect(template).toContain('.env');
+    });
+
+    it('should ignore .git folder', () => {
+      const template = getDockerignoreTemplate();
+      expect(template).toContain('.git/');
+    });
+  });
+});

src/templates/deployment/templates.test.ts

@@ -40,9 +40,10 @@ ${cmd.start}
 
 The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable.
 
-## API Endpoint
+## API Endpoints
 
 - **POST /mcp** - Main MCP endpoint for JSON-RPC messages
+- **GET /health** - Health check endpoint (returns 200 OK)
 
 ## Included Examples
 
@@ -69,11 +70,22 @@ ${projectName}/
 ├── src/
 │   ├── server.ts     # FastMCP server definition (tools, prompts, resources)
 │   └── index.ts      # Server startup configuration
+├── Dockerfile        # Multi-stage Docker build
 ├── package.json
 ├── tsconfig.json
 └── README.md
 \`\`\`
 
+## Deployment
+
+### Docker
+
+Build and run the Docker container:
+
+\`\`\`bash
+docker build -t ${projectName} .
+docker run -p 3000:3000 ${projectName}
+\`\`\`
 ## Customization
 
 - Add new tools, prompts, and resources in \`src/server.ts\`