create-mcp-kit 0.0.6 → 0.0.8

package/template/client-js/_github/workflows/npm-publish.yml.hbs

@@ -0,0 +1,41 @@
+{{#if (includes plugins 'github-action')}}
+name: npm-publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    if: github.repository == '{{projectName}}'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+          cache: npm
+
+      - name: Install Package
+        run: npm i
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build Package
+        run: npm run build
+
+      - name: Publish NPM Package
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+{{/if}}

package/template/client-js/_husky/commit-msg.hbs

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

package/template/client-js/_husky/pre-commit.hbs

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

package/template/client-js/changelog-option.js.hbs

@@ -0,0 +1,89 @@
+{{#if (includes plugins 'changelog')}}
+import compareFunc from 'compare-func'
+
+export default {
+  writerOpts: {
+    transform: (commit, context) => {
+      let discard = true
+      const issues = []
+
+      const newCommit = {
+        ...commit,
+        notes: commit.notes.map(note => ({
+          ...note,
+          title: 'BREAKING CHANGES',
+        })),
+      }
+
+      if (newCommit.notes.length > 0) {
+        discard = false
+      }
+
+      const typeMap = {
+        feat: '✨ Features | 新功能',
+        fix: '🐛 Bug Fixes | Bug 修复',
+        perf: '⚡ Performance Improvements | 性能优化',
+        revert: '⏪ Reverts | 回退',
+        refactor: '♻ Code Refactoring | 代码重构',
+        test: '✅ Tests | 测试',
+        build: '👷‍ Build System | 构建',
+        chore: '🎫 Chores | 其他更新',
+        style: '💄 Styles | 风格',
+        ci: '🔧 Continuous Integration | CI 配置',
+        docs: '📝 Documentation | 文档',
+      }
+
+      if (typeMap[newCommit.type]) {
+        newCommit.type = typeMap[newCommit.type]
+      } else if (newCommit.type === 'revert' || newCommit.revert) {
+        newCommit.type = typeMap['revert']
+      } else if (discard) {
+        return
+      }
+
+      if (newCommit.scope === '*') {
+        newCommit.scope = ''
+      }
+
+      if (typeof newCommit.hash === 'string') {
+        newCommit.shortHash = newCommit.hash.substring(0, 7)
+      }
+
+      if (typeof newCommit.subject === 'string') {
+        let url = context.repository ? `${context.host}/${context.owner}/${context.repository}` : context.repoUrl
+
+        if (url) {
+          url = `${url}/issues/`
+          newCommit.subject = newCommit.subject.replace(/#([0-9]+)/g, (_, issue) => {
+            issues.push(issue)
+            return `[#${issue}](${url}${issue})`
+          })
+        }
+
+        if (context.host) {
+          newCommit.subject = newCommit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
+            if (username.includes('/')) {
+              return `@${username}`
+            }
+            return `[@${username}](${context.host}/${username})`
+          })
+        }
+      }
+
+      newCommit.references = newCommit.references.filter(reference => {
+        if (issues.indexOf(reference.issue) === -1) {
+          return true
+        }
+        return false
+      })
+
+      return newCommit
+    },
+    groupBy: 'type',
+    commitGroupsSort: 'title',
+    commitsSort: ['scope', 'subject'],
+    noteGroupsSort: 'title',
+    notesSort: compareFunc,
+  },
+}
+{{/if}}

package/template/client-js/commitlint.config.js.hbs

@@ -0,0 +1,27 @@
+{{#if (includes plugins 'commitlint')}}
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'docs',
+        'style',
+        'refactor',
+        'perf',
+        'test',
+        'build',
+        'ci',
+        'chore',
+        'revert',
+        'build',
+        'release',
+      ],
+    ],
+    'subject-case': [0],
+  },
+}
+{{/if}}

package/template/client-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/client-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.config.js", "vitest.global.js"],
+{{else}}
+  "include": ["src"],
+{{/if}}
+  "exclude": ["node_modules"]
+}

package/template/client-js/lint-staged.config.js.hbs

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

package/template/client-js/package.json.hbs

@@ -0,0 +1,66 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.0",
+  "description": "{{projectName}}",
+  "author": "zhensherlock",
+  "type": "module",
+  "license": "MIT",
+  "files": [
+    "build",
+    "LICENSE",
+    "README.md"
+  ],
+  "main": "build/index.js",
+  "scripts": {
+{{#if (includes plugins 'style')}}
+    "lint": "npx eslint \"src/**/*.js\"",
+{{/if}}
+    "build": "tsc --noEmit && cross-env NODE_ENV=production node scripts/build.js",
+    "dev": "cross-env NODE_ENV=local node scripts/dev.js",
+{{#if (includes plugins 'vitest')}}
+    "test": "vitest run",
+    "coverage": "rimraf coverage && vitest run --coverage",
+{{/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.4",
+    "dotenv": "^17.2.1"
+  },
+  "devDependencies": {
+{{#if (includes plugins 'commitlint')}}
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "@vitest/coverage-v8": "^3.2.4",
+{{/if}}
+{{#if (includes plugins 'changelog')}}
+    "compare-func": "^2.0.0",
+{{/if}}
+{{#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.9",
+{{#if (includes plugins 'style')}}
+    "eslint": "^9.34.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.3.0",
+{{/if}}
+    "husky": "^9.1.7",
+{{#if (includes plugins 'style')}}
+    "lint-staged": "^16.1.5",
+    "prettier": "^3.6.2",
+{{/if}}
+{{#if (includes plugins 'vitest')}}
+    "vitest": "^3.2.4",
+{{/if}}
+    "rimraf": "^6.0.1"
+  }
+}

package/template/client-js/scripts/base.js.hbs

@@ -0,0 +1,65 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { spawn } from 'child_process'
+import { rimraf } from 'rimraf'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const isProd = process.env.NODE_ENV === 'production'
+const isDev = process.env.NODE_ENV === 'local'
+let nodeProcess = null
+
+{{#if (or (includes transports 'streamable') (includes transports 'sse'))}}
+if (isDev) {
+  spawn('npx', ['-y', '@my-mcp-hub/node-mcp-server', 'web'], {
+    stdio: 'inherit',
+  })
+}
+
+{{/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: ['dotenv', 'timers/promises', '@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 => {
+  if (isDev) {
+    if (result.errors.length === 0) {
+      console.log('✅ Rebuild succeeded')
+    } else {
+      console.error('❌ Rebuild failed')
+    }
+    if (nodeProcess) {
+      nodeProcess.kill('SIGINT')
+    }
+    nodeProcess = spawn('node', ['./src/index.js'], {
+      stdio: 'inherit',
+    })
+  }
+}

package/template/client-js/scripts/build.js.hbs

@@ -0,0 +1,4 @@
+import esbuild from 'esbuild'
+import { config } from './base.js'
+
+esbuild.build(config).catch(() => process.exit(1))

package/template/client-js/scripts/dev.js.hbs

@@ -0,0 +1,7 @@
+import { context } from 'esbuild'
+import { config } from './base.js'
+
+const ctx = await context(config)
+await ctx.watch()
+
+console.log('🔍 Watching for changes...')

package/template/client-js/src/index.js.hbs

@@ -0,0 +1,153 @@
+import 'dotenv/config'
+import { setTimeout as sleep } from 'timers/promises'
+import { Client } from '@modelcontextprotocol/sdk/client/index.js'
+{{#if (includes transports 'stdio')}}
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js'
+{{/if}}
+{{#if (includes transports 'streamable')}}
+import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'
+{{/if}}
+{{#if (includes transports 'sse')}}
+import { SSEClientTransport } from '@modelcontextprotocol/sdk/client/sse.js'
+{{/if}}
+{{#if (includes transports 'stdio')}}
+
+export async function testStdioTransport() {
+  console.log('start stdio client transport')
+  const client = new Client({
+    name: 'mcp-stdio-client',
+    version: '1.0.0',
+  })
+
+  const stdioClientTransport = new StdioClientTransport({
+    command: 'npx',
+    args: ['-y', '@my-mcp-hub/node-mcp-server'],
+    env: {
+      ...process.env,
+    },
+  })
+
+  try {
+    await client.connect(stdioClientTransport)
+    console.log('stdio client transport connected')
+
+    const { tools } = await client.listTools()
+    console.log(tools.map(item => item.name))
+    console.log('stdio client transport tools listed')
+
+    const callResult = await client.callTool({
+      name: 'GetData',
+      arguments: {
+        keyword: 'Hello',
+      },
+    })
+    console.log(callResult.content)
+    console.log('stdio client transport call tool done')
+  } catch (error) {
+    console.error('stdio transport error:', error)
+  } finally {
+    await client.close()
+    console.log('stdio client transport closed')
+  }
+
+  console.log('stdio client transport done\n\n')
+  await sleep(1000)
+}
+{{/if}}
+{{#if (includes transports 'streamable')}}
+
+export async function testStreamableHttpTransport() {
+  console.log('start streamable http client transport')
+  const client = new Client({
+    name: 'mcp-http-client',
+    version: '1.0.0',
+  })
+
+  const streamableBaseUrl = new URL('http://localhost:8401/mcp')
+  const streamableClientTransport = new StreamableHTTPClientTransport(streamableBaseUrl)
+
+  try {
+    await client.connect(streamableClientTransport)
+    console.log('streamable http client transport connected')
+
+    const { tools } = await client.listTools()
+    console.log(tools.map(item => item.name))
+    console.log('streamable http client transport tools listed')
+
+    const callResult = await client.callTool({
+      name: 'GetData',
+      arguments: {
+        keyword: 'Hello',
+      },
+    })
+    console.log(callResult.content)
+    console.log('streamable http client transport call tool done')
+  } catch (error) {
+    console.error('streamable http transport error:', error)
+  } finally {
+    await client.close()
+    console.log('streamable http client transport closed')
+  }
+
+  console.log('streamable http client transport done\n\n')
+  await sleep(1000)
+}
+{{/if}}
+{{#if (includes transports 'sse')}}
+
+export async function testSSETransport() {
+  console.log('start sse client transport')
+  const client = new Client({
+    name: 'mcp-sse-client',
+    version: '1.0.0',
+  })
+
+  const sseBaseUrl = new URL('http://localhost:8401/sse')
+  const sseClientTransport = new SSEClientTransport(sseBaseUrl)
+
+  try {
+    await client.connect(sseClientTransport)
+    console.log('sse client transport connected')
+
+    const { tools } = await client.listTools()
+    console.log(tools.map(item => item.name))
+    console.log('sse client transport tools listed')
+
+    const callResult = await client.callTool({
+      name: 'GetData',
+      arguments: {
+        keyword: 'Hello',
+      },
+    })
+    console.log(callResult.content)
+    console.log('sse client transport call tool done')
+  } catch (error) {
+    console.error('sse transport error:', error)
+  } finally {
+    await client.close()
+    console.log('sse client transport closed')
+  }
+
+  console.log('sse client transport done\n\n')
+  await sleep(1000)
+}
+{{/if}}
+
+async function main() {
+  try {
+{{#if (includes transports 'stdio')}}
+    await testStdioTransport()
+{{/if}}
+{{#if (includes transports 'streamable')}}
+    await testStreamableHttpTransport()
+{{/if}}
+{{#if (includes transports 'sse')}}
+    await testSSETransport()
+{{/if}}
+  } catch (error) {
+    console.error('Main error:', error)
+    process.exit(1)
+  }
+}
+
+await main()

package/template/client-js/tests/index.test.js.hbs

@@ -0,0 +1,22 @@
+{{#if (includes plugins 'vitest')}}
+import { describe, test } from 'vitest'
+import { {{#each transports}} {{~#if (eq this "stdio")}}testStdioTransport{{/if}} {{~#if (eq this "streamable")}}testStreamableHttpTransport{{/if}} {{~#if (eq this "sse")}}testSSETransport{{/if}}{{~#unless @last}}, {{/unless}}{{/each}} } from '@/index.js'
+
+describe('MCP client', () => {
+  {{#if (includes transports 'stdio')}}
+  test('stdio transport', async () => {
+    await testStdioTransport()
+  })
+  {{/if}}
+  {{#if (includes transports 'streamable')}}
+  test('streamable http transport', async () => {
+    await testStreamableHttpTransport()
+  })
+  {{/if}}
+  {{#if (includes transports 'sse')}}
+  test('sse transport', async () => {
+    await testSSETransport()
+  })
+  {{/if}}
+})
+{{/if}}

package/template/{server-js/tests/utils.js → client-js/tests/utils.js.hbs}

@@ -1,3 +1,4 @@
+{{#if (includes plugins 'vitest')}}
 export function waitForValue(getterFn, checkInterval = 100, timeout = 10000) {
   return new Promise((resolve, reject) => {
     const start = Date.now()
@@ -14,3 +15,4 @@ export function waitForValue(getterFn, checkInterval = 100, timeout = 10000) {
     }, checkInterval)
   })
 }
+{{/if}}

package/template/client-js/vitest.config.js.hbs

@@ -0,0 +1,27 @@
+{{#if (includes plugins 'vitest')}}
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@': '/src',
+    },
+  },
+  test: {
+  {{#if (or (includes transports 'streamable') (includes transports 'sse'))}}
+    globalSetup: ['./vitest.global.js'],
+  {{/if}}
+    coverage: {
+      include: ['src/**/*.js'],
+      reporter: ['text', 'lcov', 'html'],
+    },
+    pool: 'threads',
+    poolOptions: {
+      threads: {
+        maxThreads: 1,
+        minThreads: 1,
+      },
+    },
+  },
+})
+{{/if}}

package/template/client-js/vitest.global.js.hbs

@@ -0,0 +1,21 @@
+{{#if (and (includes plugins 'vitest') (or (includes transports 'streamable') (includes transports 'sse')))}}
+import { spawn } from 'child_process'
+import { waitForValue } from './tests/utils'
+
+export default async function setup() {
+  const webProcess = spawn('npx', ['-y', '@my-mcp-hub/node-mcp-server', 'web'], {
+    stdio: 'pipe',
+  })
+  let webStarted = false
+  webProcess.stdout.on('data', async (data) => {
+    const output = data.toString()
+    if (output.includes('MCP server started')) {
+      webStarted = true
+    }
+  });
+  await waitForValue(() => webStarted)
+  return () => {
+    webProcess.kill('SIGINT')
+  }
+}
+{{/if}}