create-mcp-kit 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,12 @@
 # create-mcp-kit
 A CLI tool to create MCP (Model Context Protocol) applications with ease.
 
+[![][npm-release-shield]][npm-release-link]
+[![][codecov-shield]][codecov-link]
+[![][github-release-date-shield]][github-release-date-link]
+[![][github-action-build-shield]][github-action-build-link]
+[![][github-license-shield]][github-license-link]
+
 ## Features
 - 🚀 Quick project scaffolding
 - 📦 TypeScript support out of the box
@@ -123,3 +129,14 @@ This project exists thanks to all the people who contribute.
 ## License
 
 [MIT](LICENSE) © MichaelSun
+
+[npm-release-link]: https://www.npmjs.com/package/create-mcp-kit
+[npm-release-shield]: https://img.shields.io/npm/v/create-mcp-kit?color=1677FF&labelColor=black&logo=npm&logoColor=white&style=flat-square
+[codecov-link]: https://coveralls.io/github/my-mcp-hub/mcp-kit?branch=main
+[codecov-shield]: https://img.shields.io/coverallsCoverage/github/my-mcp-hub/mcp-kit?color=1677FF&labelColor=black&style=flat-square&logo=codecov&logoColor=white
+[github-release-date-link]: https://github.com/my-mcp-hub/mcp-kit/releases
+[github-release-date-shield]: https://img.shields.io/github/release-date/my-mcp-hub/mcp-kit?color=1677FF&labelColor=black&style=flat-square
+[github-action-build-link]: https://github.com/my-mcp-hub/mcp-kit/actions/workflows/build.yml
+[github-action-build-shield]: https://img.shields.io/github/actions/workflow/status/my-mcp-hub/mcp-kit/build.yml?branch=main&color=1677FF&label=build&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
+[github-license-link]: https://github.com/my-mcp-hub/mcp-kit/blob/main/LICENSE
+[github-license-shield]: https://img.shields.io/github/license/my-mcp-hub/mcp-kit?color=1677FF&labelColor=black&style=flat-square

package/dist/index.js

@@ -1,15 +1,32 @@
 #!/usr/bin/env node
-import * as clack from "@clack/prompts";
-import pc from "picocolors";
 import { fileURLToPath } from "url";
 import { dirname, join, resolve } from "path";
-import { stat } from "fs/promises";
-import { createProject, installDependencies, sleep } from "@mcp-tool-kit/shared";
+import * as clack from "@clack/prompts";
+import pc from "picocolors";
+import gradient from "gradient-string";
+import { createProject, fileExists, installDependencies, sleep } from "@mcp-tool-kit/shared";
 
 //#region src/index.ts
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
-clack.intro(pc.inverse(" create-mcp-kit "));
+clack.intro(gradient([
+	{
+		color: "#a855f7",
+		pos: 0
+	},
+	{
+		color: "#3b82f6",
+		pos: .4
+	},
+	{
+		color: "#06b6d4",
+		pos: .8
+	},
+	{
+		color: "#10b981",
+		pos: 1
+	}
+])("MCP Kit - The Modern Context Protocol Builder"));
 const group = await clack.group({
 	type: () => clack.select({
 		message: "Project type:",
@@ -28,39 +45,109 @@ const group = await clack.group({
 		options: [{
 			value: "ts",
 			label: pc.magenta("TypeScript")
+		}, {
+			value: "js",
+			label: pc.blue("JavaScript")
 		}]
 	}),
 	template: () => clack.select({
 		message: "Project template:",
 		options: [{
 			value: "standard",
-			label: pc.magenta("Standard")
+			label: pc.magenta("Standard (recommended)")
+		}, {
+			value: "custom",
+			label: pc.blue("Custom")
 		}]
 	}),
+	transports: () => {
+		return clack.multiselect({
+			message: "Project Transport Type:",
+			required: true,
+			initialValues: ["stdio"],
+			options: [
+				{
+					value: "stdio",
+					label: pc.magenta("STDIO")
+				},
+				{
+					value: "streamable",
+					label: pc.blue("Streamable HTTP")
+				},
+				{
+					value: "sse",
+					label: pc.yellow("SSE")
+				}
+			]
+		});
+	},
+	plugins: ({ results }) => {
+		if (results.template !== "custom") return Promise.resolve([
+			"github-action",
+			"vitest",
+			"inspector",
+			"style",
+			"commitlint",
+			"changelog"
+		]);
+		return clack.multiselect({
+			message: "Project plugins:",
+			required: false,
+			options: [
+				{
+					value: "github-action",
+					label: pc.magenta("GitHub Action")
+				},
+				{
+					value: "vitest",
+					label: pc.green("Vitest")
+				},
+				{
+					value: "inspector",
+					label: pc.blue("Inspector")
+				},
+				{
+					value: "style",
+					label: pc.white("ESLint + Prettier + Lint-staged")
+				},
+				{
+					value: "commitlint",
+					label: pc.gray("Commitlint")
+				},
+				{
+					value: "changelog",
+					label: pc.blueBright("Changelog")
+				}
+			]
+		});
+	},
 	install: () => clack.confirm({ message: "Do you want to install dependencies?" })
 }, { onCancel: () => {
 	clack.cancel("Operation cancelled.");
 	process.exit(0);
 } });
-const templatePath = join(__dirname, "../template", `${group.template}-${group.language}`);
+const templatePath = join(__dirname, "../template", `${group.type}-${group.template}-${group.language}`);
 const targetPath = resolve(process.cwd(), group.name);
-try {
-	await stat(templatePath);
-} catch {
+if (!await fileExists(templatePath)) {
 	clack.log.error(`Template not found: ${templatePath}`);
 	process.exit(1);
 }
-try {
-	await stat(targetPath);
+if (await fileExists(targetPath)) {
 	clack.log.error(`Directory ${group.name} already exists`);
 	process.exit(1);
-} catch {}
+}
 {
 	const createSpinner = clack.spinner();
 	createSpinner.start("Creating project...");
 	await sleep(100);
 	try {
-		await createProject(targetPath, templatePath, { projectName: group.name });
+		await createProject(targetPath, templatePath, {
+			projectName: group.name,
+			year: (/* @__PURE__ */ new Date()).getFullYear().toString(),
+			transports: group.transports,
+			plugins: group.plugins,
+			components: []
+		});
 	} catch (error) {
 		createSpinner.stop("Failed to create project");
 		clack.log.error(error.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-mcp-kit",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "create mcp tool kit",
   "type": "module",
   "author": "zhensherlock",
@@ -40,8 +40,10 @@
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",
+    "gradient-string": "^3.0.0",
+    "handlebars": "^4.7.8",
     "picocolors": "^1.1.1",
-    "@mcp-tool-kit/shared": "^0.0.3"
+    "@mcp-tool-kit/shared": "^0.0.5"
   },
   "devDependencies": {
     "@modelcontextprotocol/sdk": "^1.17.1",

package/template/{standard-ts/_prettierrc → server-standard-js/.prettierrc.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'style')}}
 {
   "tabWidth": 2,
   "printWidth": 120,
@@ -9,3 +10,4 @@
   "jsxBracketSameLine": false,
   "arrowParens": "avoid"
 }
+{{/if}}

package/template/{standard-ts/LICENSE → server-standard-js/LICENSE.hbs}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) {{YEAR}} {{PROJECT_NAME}}
+Copyright (c) {{year}} {{projectName}}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/template/{standard-ts/_github/workflows/build.yml → server-standard-js/_github/workflows/build.yml.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'github-action')}}
 name: build
 
 on:
@@ -7,7 +8,7 @@ on:
 
 jobs:
   build:
-    if: github.repository == '{{PROJECT_NAME}}'
+    if: github.repository == '{{projectName}}'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -24,6 +25,9 @@ jobs:
       - name: Install Package
         run: npm i
 
+      - name: Lint
+        run: npm run lint
+
       - name: Build Package
         run: npm run build
 
@@ -32,3 +36,4 @@ jobs:
 
       - name: Coveralls
         uses: coverallsapp/github-action@v2
+{{/if}}

package/template/{standard-ts/_github/workflows/npm-publish.yml → server-standard-js/_github/workflows/npm-publish.yml.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'github-action')}}
 name: npm-publish
 
 on:
@@ -6,7 +7,7 @@ on:
 
 jobs:
   build:
-    if: github.repository == '{{PROJECT_NAME}}'
+    if: github.repository == '{{projectName}}'
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -27,6 +28,9 @@ jobs:
       - name: Install Package
         run: npm i
 
+      - name: Lint
+        run: npm run lint
+
       - name: Build Package
         run: npm run build
 
@@ -34,3 +38,4 @@ jobs:
         run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+{{/if}}

package/template/server-standard-js/_husky/commit-msg.hbs

@@ -0,0 +1,3 @@
+{{#if (includes plugins 'commitlint')}}
+npx --no-install commitlint --edit $1
+{{/if}}

package/template/server-standard-js/_husky/pre-commit.hbs

@@ -0,0 +1,3 @@
+{{#if (includes plugins 'style')}}
+npx lint-staged
+{{/if}}

package/template/{standard-ts/changelog-option.js → server-standard-js/changelog-option.js.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'changelog')}}
 import compareFunc from 'compare-func'
 
 export default {
@@ -85,3 +86,4 @@ export default {
     notesSort: compareFunc,
   },
 }
+{{/if}}

package/template/{standard-ts/commitlint.config.js → server-standard-js/commitlint.config.js.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'commitlint')}}
 export default {
   extends: ['@commitlint/config-conventional'],
   rules: {
@@ -23,3 +24,4 @@ export default {
     'subject-case': [0],
   },
 }
+{{/if}}

package/template/server-standard-js/eslint.config.js.hbs

@@ -0,0 +1,48 @@
+{{#if (includes plugins 'style')}}
+import importPlugin from 'eslint-plugin-import'
+import prettierPlugin from 'eslint-plugin-prettier'
+import globals from 'globals'
+
+export default [
+  {
+    ignores: ['**/build', '**/node_modules', '**/.*', '.husky/'],
+  },
+  {
+  {{#if (includes plugins 'vitest')}}
+    files: ['src/**/*.js', 'tests/**/*.js'],
+  {{else}}
+    files: ['src/**/*.js'],
+  {{/if}}
+  },
+  {
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+      globals: {
+        ...globals.es2022,
+        ...globals.node,
+      },
+    },
+    plugins: {
+      import: importPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      'prettier/prettier': 'error',
+      'no-console': 'off',
+      semi: ['warn', 'never'],
+      quotes: ['warn', 'single'],
+      'no-unused-vars': 'off',
+    },
+    settings: {
+      'import/resolver': {
+        node: {
+          extensions: ['.js'],
+        },
+      },
+    },
+  },
+]
+{{/if}}

package/template/server-standard-js/jsconfig.json.hbs

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "outDir": "./build",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+{{#if (includes plugins 'vitest')}}
+  "include": ["src", "tests", "vitest.setup.js", "vitest.config.js"],
+{{else}}
+  "include": ["src"],
+{{/if}}
+  "exclude": ["node_modules"]
+}

package/template/server-standard-js/lint-staged.config.js.hbs

@@ -0,0 +1,5 @@
+{{#if (includes plugins 'style')}}
+export default {
+  'src/**/*.js': ['npx eslint'],
+}
+{{/if}}

package/template/server-standard-js/package.json.hbs

@@ -0,0 +1,97 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.0",
+  "description": "{{projectName}}",
+  "author": "zhensherlock",
+  "type": "module",
+  "license": "MIT",
+  "bin": {
+    "{{projectName}}": "./build/index.js"
+  },
+  "files": [
+    "build",
+    "LICENSE",
+    "README.md"
+  ],
+  "main": "build/index.js",
+  "scripts": {
+{{#if (includes plugins 'style')}}
+    "lint": "npx eslint \"src/**/*.js\"",
+{{/if}}
+    "build": "cross-env NODE_ENV=production node scripts/build.js",
+{{#if (and (includes transports 'stdio') (or (includes transports 'streamable') (includes transports 'sse')))}}
+    "dev": "npm run dev:stdio",
+    "dev:stdio": "cross-env NODE_ENV=local node scripts/dev.js",
+{{else if (includes transports 'web')}}
+    "dev": "npm run dev:stdio",
+    "dev:stdio": "cross-env NODE_ENV=local node scripts/dev.js",
+{{else}}
+    "dev": "npm run dev:web",
+    "dev:web": "cross-env NODE_ENV=local TRANSPORT=web node scripts/dev.js",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "test": "vitest run",
+    "coverage": "rimraf coverage && npm run test && c8 report --reporter=lcov --reporter=html",
+{{/if}}
+{{#if (includes plugins 'changelog')}}
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 -n changelog-option.js",
+{{/if}}
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.17.1",
+    "dotenv": "^17.2.1",
+{{#if (or (includes transports 'streamable') (includes transports 'sse'))}}
+    "express": "^5.1.0",
+    "nanoid": "^5.1.5",
+{{/if}}
+    "yargs": "^17.7.2",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+{{#if (includes plugins 'commitlint')}}
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+{{/if}}
+{{#if (includes plugins 'inspector')}}
+    "@modelcontextprotocol/inspector": "^0.16.2",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "@vitest/coverage-v8": "^3.2.4",
+    "c8": "^10.1.3",
+{{/if}}
+{{#if (includes plugins 'changelog')}}
+    "compare-func": "^2.0.0",
+{{/if}}
+    "concurrently": "^9.2.0",
+{{#if (includes plugins 'changelog')}}
+    "conventional-changelog-angular": "^8.0.0",
+    "conventional-changelog-cli": "^5.0.0",
+{{/if}}
+    "cross-env": "^10.0.0",
+    "esbuild": "^0.25.8",
+{{#if (includes plugins 'style')}}
+    "eslint": "^9.32.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.3",
+    "globals": "^16.3.0",
+{{/if}}
+    "husky": "^9.1.7",
+{{#if (includes plugins 'style')}}
+    "lint-staged": "^16.1.4",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "nyc": "^17.1.0",
+{{/if}}
+{{#if (includes plugins 'style')}}
+    "prettier": "^3.6.2",
+{{/if}}
+{{#if (includes plugins 'inspector')}}
+    "tree-kill": "^1.2.2",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "vitest": "^3.2.4",
+{{/if}}
+    "rimraf": "^6.0.1"
+  }
+}

package/template/server-standard-js/scripts/base.js.hbs

@@ -0,0 +1,88 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { promises as fs } from 'fs'
+{{#if (includes plugins 'inspector')}}
+import { spawn } from 'child_process'
+{{/if}}
+import { rimraf } from 'rimraf'
+{{#if (includes plugins 'inspector')}}
+import kill from 'tree-kill'
+{{/if}}
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const isProd = process.env.NODE_ENV === 'production'
+const isDev = process.env.NODE_ENV === 'local'
+{{#if (includes plugins 'inspector')}}
+let inspectorProcess = null
+let webProcess = null
+let autoOpenBrowser = true
+{{/if}}
+
+/** @type {import('esbuild').BuildOptions} */
+export const config = {
+  entryPoints: [path.resolve(__dirname, '../src/index.js')],
+  outfile: path.resolve(__dirname, '../build/index.js'),
+  format: 'esm',
+  bundle: true,
+  sourcemap: isDev,
+  minify: isProd,
+  platform: 'node',
+  external: ['yargs', 'express', 'nanoid', 'zod', 'dotenv', '@modelcontextprotocol/sdk'],
+  alias: {
+    '@': path.resolve(__dirname, '../src'),
+  },
+  plugins: [
+    {
+      name: 'build-plugin',
+      setup(build) {
+        build.onStart(async result => {
+          await before(result)
+        })
+        build.onEnd(async result => {
+          await after(result)
+        })
+      },
+    },
+  ],
+}
+
+const before = async () => {
+  await rimraf('build')
+}
+
+const after = async result => {
+  await fs.chmod('build/index.js', 0o755)
+  console.log('✅ chmod 755 build/index.js done')
+  if (isDev) {
+    if (result.errors.length === 0) {
+      console.log('✅ Rebuild succeeded')
+    } else {
+      console.error('❌ Rebuild failed')
+    }
+{{#if (includes plugins 'inspector')}}
+    console.log('🚀 Starting @modelcontextprotocol/inspector...')
+    if (inspectorProcess) {
+      kill(inspectorProcess.pid, 'SIGINT')
+    }
+    inspectorProcess = spawn('npx', ['@modelcontextprotocol/inspector', 'build/index.js'], {
+      stdio: 'inherit',
+      shell: true,
+      env: {
+        ...process.env,
+        DANGEROUSLY_OMIT_AUTH: true,
+        MCP_AUTO_OPEN_ENABLED: autoOpenBrowser,
+      },
+    })
+    autoOpenBrowser = false
+
+    if (process.env.TRANSPORT === 'web') {
+      if (webProcess) {
+        webProcess.kill('SIGINT')
+      }
+      webProcess = spawn('node', ['build/index.js', 'web'], {
+        stdio: 'inherit',
+      })
+    }
+{{/if}}
+  }
+}

package/template/server-standard-js/src/index.js.hbs

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+{{#if (and (includes transports 'stdio') (or (includes transports 'streamable') (includes transports 'sse')))}}
+import { startWebServer, startStdioServer } from './services/index.js'
+{{else if (includes transports 'stdio')}}
+import { startStdioServer } from './services/index.js'
+{{else}}
+import { startWebServer } from './services/index.js'
+{{/if}}
+import { getOptions } from './utils/index.js'
+import 'dotenv/config'
+import pkg from '../package.json' with { type: 'json' }
+
+const name = '{{projectName}}'
+
+const argv = await yargs()
+  .scriptName(name)
+  .usage('$0 <command> [options]')
+{{#if (includes transports 'stdio')}}
+  .command(
+    'stdio',
+    'Start the server using the stdio transport protocol.',
+    () => {},
+    argv => startServer('stdio', argv),
+  )
+{{/if}}
+{{#if (or (includes transports 'streamable') (includes transports 'sse'))}}
+  .command(
+    'web',
+    'Start the web server transport protocol.',
+    () => {},
+    argv => startServer('web', argv),
+  )
+{{/if}}
+{{#if (or (includes transports 'streamable') (includes transports 'sse'))}}
+  .options({
+    port: {
+      describe: 'Specify the port for SSE or streamable transport (default: 8401)',
+      type: 'string',
+      default: process.env.PORT || '8401',
+    },
+  })
+{{/if}}
+  .help()
+  .parse(hideBin(process.argv))
+
+if (!argv._[0]) {
+{{#if (includes transports 'stdio')}}
+  startServer('stdio', argv)
+{{else}}
+  startServer('web', argv)
+{{/if}}
+}
+
+async function startServer(mode, argv) {
+  const options = getOptions(argv, {
+    name,
+    version: pkg.version,
+  })
+  {{#if (and (includes transports 'stdio') (or (includes transports 'streamable') (includes transports 'sse')))}}
+  if (mode === 'stdio') {
+    startStdioServer(options).catch(console.error)
+  } else if (mode === 'web') {
+    startWebServer(options).catch(console.error)
+  }
+  {{else if (includes transports 'stdio')}}
+  if (mode === 'stdio') {
+    startStdioServer(options).catch(console.error)
+  }
+  {{else}}
+  if (mode === 'web') {
+    startWebServer(options).catch(console.error)
+  }
+  {{/if}}
+}

package/template/server-standard-js/src/prompts/index.js

@@ -0,0 +1,27 @@
+import { z } from 'zod'
+
+export const registerPrompts = server => {
+  server.registerPrompt(
+    'echo',
+    {
+      title: 'Echo Prompt',
+      description: 'Creates a prompt to process a message.',
+      argsSchema: {
+        message: z.string(),
+      },
+    },
+    ({ message }) => {
+      return {
+        messages: [
+          {
+            role: 'user',
+            content: {
+              type: 'text',
+              text: `Please process this message: ${message}`,
+            },
+          },
+        ],
+      }
+    },
+  )
+}