create-mcp-kit 0.0.6 → 0.0.8

package/README.md

@@ -1,4 +1,4 @@
-# create-mcp-kit
+# Create-MCP-Kit
 A CLI tool to create MCP (Model Context Protocol) applications with ease.
 
 [![][npm-release-shield]][npm-release-link]
@@ -12,6 +12,8 @@ A CLI tool to create MCP (Model Context Protocol) applications with ease.
 - 📦 TypeScript support out of the box
 - 🛠️ Built-in development tools
 - 🔧 Configurable project templates
+- 🌐 Multiple Transport Modes (stdio/streamable-http/sse)
+- 📚 Comprehensive APIs
 
 ## Usage
 
@@ -31,85 +33,275 @@ or
 pnpm create mcp-kit@latest
 ```
 
-## Project Structure
+## Project Types
+
+create-mcp-kit supports generating two types of projects:
+
+### MCP Server
+
+Create an MCP server that provides tools, resources, and prompts for MCP clients.
+
+#### Server Project Structure
 
 ```text
-The generated project will have the following structure:
+The generated server project will have the following structure:
 
 ├── src/
 │   ├── tools/          # MCP tools implementation
+│   │   ├── index.ts    # Tools registration
+│   │   └── register*.ts # Individual tool implementations
 │   ├── resources/      # MCP resources implementation
+│   │   └── index.ts    # Resources registration
 │   ├── prompts/        # MCP prompts implementation
-│   ├── services/       # Server implementations (stdio/web)
+│   │   └── index.ts    # Prompts registration
+│   ├── services/       # Server implementations
+│   │   ├── stdio.ts    # STDIO transport implementation
+│   │   └── web.ts      # Streamable HTTP and SSE transport implementation
 │   └── index.ts        # Entry point
-├── tests/              # Test files
+├── tests/              # Test files (optional)
+├── scripts/            # Build and development scripts
+├── .github/            # GitHub Actions workflows (optional)
+├── .husky/             # Git hooks (optional)
+└── package.json
+```
+
+#### Server Development Scripts
+
+- `npm run dev` - Start the development server in stdio mode
+- `npm run dev:web` - Start the development server in web mode
+- `npm run build` - Build the project
+- `npm run test` - Run tests (if vitest plugin is selected)
+- `npm run coverage` - Generate test coverage report (if vitest plugin is selected)
+- `npm run lint` - Run linting (if style plugin is selected)
+
+### MCP Client
+
+Create an MCP client that connects to MCP servers and uses their tools, resources, and prompts.
+
+#### Client Project Structure
+
+```text
+The generated client project will have the following structure:
+
+├── src/
+│   └── index.ts        # Entry point with transport implementations
+├── tests/              # Test files (optional)
 ├── scripts/            # Build and development scripts
-├── .github/            # GitHub Actions workflows
+├── .github/            # GitHub Actions workflows (optional)
+├── .husky/             # Git hooks (optional)
 └── package.json
 ```
 
-## Development Scripts
+#### Client Development Scripts
 
-- npm run dev - Start the development server in stdio mode
-- npm run dev:web - Start the development server in web mode
-- npm run build - Build the project
-- npm run test - Run tests
-- npm run coverage - Generate test coverage report
+- `npm run dev` - Start the client in development mode
+- `npm run build` - Build the project
+- `npm run test` - Run tests (if vitest plugin is selected)
+- `npm run coverage` - Generate test coverage report (if vitest plugin is selected)
+- `npm run lint` - Run linting (if style plugin is selected)
 
 ## Features
-### MCP Tools
+
+### MCP Server Features
+
+#### Transport Modes
+
+MCP Server supports three transport modes:
+
+1. **STDIO**: Communication through standard input/output streams
+2. **Streamable HTTP**: RESTful API with streaming capabilities
+3. **SSE (Server-Sent Events)**: Real-time event streaming from server to client
+
+#### MCP Tools
 Implement custom tools that can be used by MCP clients:
 
 ```ts
-server.registerTool(
-  'GetData',
-  {
-    title: 'Get Data',
-    description: 'Get Data',
-    inputSchema: {
-      keyword: z.string().describe('search keyword'),
+// Full implementation example
+import { z } from 'zod'
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+
+export default function register(server, options) {
+  server.registerTool(
+    'GetData',
+    {
+      title: 'Get Data',
+      description: 'Get Data',
+      inputSchema: {
+        keyword: z.string().describe('search keyword'),
+      },
     },
-  },
-  async ({ keyword }) => {
-    // Your implementation
+    async ({ keyword }) => {
+      const { success, data, message } = await getData(keyword, options)
+      return {
+        content: [
+          {
+            type: 'text',
+            text: success ? data : message,
+          },
+        ],
+      }
+    },
+  )
+}
+
+export const getData = async (keyword, options) => {
+  if (!keyword || keyword === 'error') {
+    return {
+      success: false,
+      message: 'Invalid keyword',
+    }
+  }
+
+  return {
+    success: true,
+    data: `Data for ${keyword}`,
   }
-)
+}
 ```
-### MCP Resources
+
+#### MCP Resources
 Define resources that can be accessed by MCP clients:
 
 ```ts
-server.registerResource(
-  'search',
-  new ResourceTemplate('search://{keyword}', {
-    list: undefined,
-  }),
-  {
-    title: 'Search Resource',
-    description: 'Dynamic generate search resource',
-  },
-  async (uri, { keyword }) => {
-    // Your implementation
-  }
-)
+// Full implementation example
+import { type McpServer, ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js'
+import type { OptionsType } from '@/types'
+
+export const registerResources = (server: McpServer, options: OptionsType) => {
+  server.registerResource(
+    'search',
+    new ResourceTemplate('search://{keyword}', {
+      list: undefined,
+    }),
+    {
+      title: 'Search Resource',
+      description: 'Dynamic generate search resource',
+    },
+    async (uri, { keyword }) => {
+      return {
+        contents: [
+          {
+            uri: uri.href,
+            text: `search ${keyword}`,
+          },
+        ],
+      }
+    },
+  )
+}
 ```
-### MCP Prompts
+
+#### MCP Prompts
 Create reusable prompts for MCP clients:
 
 ```ts
-server.registerPrompt(
-  'echo',
-  {
-    title: 'Echo Prompt',
-    description: 'Creates a prompt to process a message.',
-    argsSchema: {
-      message: z.string(),
+// Full implementation example
+import { z } from 'zod'
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+
+export const registerPrompts = (server: McpServer) => {
+  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}`,
+            },
+          },
+        ],
+      }
+    },
+  )
+}
+```
+
+### MCP Client Features
+
+#### Multiple Transport Modes
+Connect to MCP servers using different transport modes:
+
+```ts
+// Import the MCP client
+import { McpClient } from '@modelcontextprotocol/sdk/client/mcp.js'
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/transports/stdio.js'
+import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/transports/streamable-http.js'
+import { SSEClientTransport } from '@modelcontextprotocol/sdk/client/transports/sse.js'
+
+// Create a new MCP client
+const client = new McpClient()
+
+// STDIO Transport
+const stdioClientTransport = new StdioClientTransport({
+  command: 'npx',
+  args: ['-y', '@my-mcp-hub/node-mcp-server'],
+  env: process.env,
+})
+await client.connect(stdioClientTransport)
+
+// Streamable HTTP Transport
+const streamableBaseUrl = new URL('http://localhost:8401/mcp')
+const streamableClientTransport = new StreamableHTTPClientTransport(streamableBaseUrl)
+await client.connect(streamableClientTransport)
+
+// SSE Transport
+const sseBaseUrl = new URL('http://localhost:8401/sse')
+const sseClientTransport = new SSEClientTransport(sseBaseUrl)
+await client.connect(sseClientTransport)
+```
+
+#### Tool Calling
+Call tools provided by MCP servers:
+
+```ts
+// List available tools
+const tools = await client.listTools()
+console.log(tools)
+
+// Call a tool
+const callResult = await client.callTool({
+  name: 'GetData',
+  arguments: {
+    keyword: 'Hello',
   },
-  ({ message }) => {
-    // Your implementation
-  }
-)
+})
+console.log(callResult.content)
+```
+
+#### Resource Access
+Access resources provided by MCP servers:
+
+```ts
+// List available resources
+const resources = await client.listResources()
+console.log(resources)
+
+// Get a resource
+const resource = await client.getResource('search://example')
+console.log(resource.contents)
+```
+
+#### Prompt Usage
+Use prompts provided by MCP servers:
+
+```ts
+// List available prompts
+const prompts = await client.listPrompts()
+console.log(prompts)
+
+// Use a prompt
+const prompt = await client.getPrompt('echo', { message: 'Hello, world!' })
+console.log(prompt.messages)
 ```
 
 ## Contributing

package/dist/index.js

@@ -32,7 +32,10 @@ const group = await clack.group({
 		message: "Project type:",
 		options: [{
 			value: "server",
-			label: pc.magenta("MCP Server")
+			label: pc.magentaBright("MCP Server")
+		}, {
+			value: "client",
+			label: pc.greenBright("MCP Client")
 		}]
 	}),
 	name: ({ results }) => clack.text({
@@ -44,10 +47,10 @@ const group = await clack.group({
 		message: "Project language:",
 		options: [{
 			value: "ts",
-			label: pc.magenta("TypeScript")
+			label: pc.magentaBright("TypeScript")
 		}, {
 			value: "js",
-			label: pc.blue("JavaScript")
+			label: pc.greenBright("JavaScript")
 		}]
 	}),
 	transports: () => {
@@ -58,15 +61,15 @@ const group = await clack.group({
 			options: [
 				{
 					value: "stdio",
-					label: pc.magenta("STDIO")
+					label: pc.magentaBright("STDIO")
 				},
 				{
 					value: "streamable",
-					label: pc.blue("Streamable HTTP")
+					label: pc.greenBright("Streamable HTTP")
 				},
 				{
 					value: "sse",
-					label: pc.yellow("SSE")
+					label: pc.yellowBright("SSE")
 				}
 			]
 		});
@@ -75,17 +78,17 @@ const group = await clack.group({
 		message: "Project template:",
 		options: [{
 			value: "standard",
-			label: pc.magenta("Standard (recommended)")
+			label: pc.magentaBright("Standard (recommended)")
 		}, {
 			value: "custom",
-			label: pc.blue("Custom")
+			label: pc.greenBright("Custom")
 		}]
 	}),
 	plugins: ({ results }) => {
 		if (results.template !== "custom") return Promise.resolve([
 			"github-action",
 			"vitest",
-			"inspector",
+			...results.type === "server" ? ["inspector"] : [],
 			"style",
 			"commitlint",
 			"changelog"
@@ -96,23 +99,23 @@ const group = await clack.group({
 			options: [
 				{
 					value: "github-action",
-					label: pc.magenta("GitHub Action")
+					label: pc.magentaBright("GitHub Action")
 				},
 				{
 					value: "vitest",
-					label: pc.green("Vitest")
+					label: pc.greenBright("Vitest")
 				},
-				{
+				...results.type === "server" ? [{
 					value: "inspector",
-					label: pc.blue("Inspector")
-				},
+					label: pc.cyanBright("Inspector")
+				}] : [],
 				{
 					value: "style",
-					label: pc.white("ESLint + Prettier + Lint-staged")
+					label: pc.yellowBright("ESLint + Prettier + Lint-staged")
 				},
 				{
 					value: "commitlint",
-					label: pc.gray("Commitlint")
+					label: pc.redBright("Commitlint")
 				},
 				{
 					value: "changelog",
@@ -137,8 +140,6 @@ if (await fileExists(targetPath)) {
 	process.exit(1);
 }
 {
-	const createSpinner = clack.spinner();
-	createSpinner.start("Creating project...");
 	await sleep(100);
 	try {
 		await createProject(targetPath, templatePath, {
@@ -149,11 +150,9 @@ if (await fileExists(targetPath)) {
 			components: []
 		});
 	} catch (error) {
-		createSpinner.stop("Failed to create project");
 		clack.log.error(error.message);
 		process.exit(1);
 	}
-	createSpinner.stop(pc.green("Project created!"));
 }
 if (group.install) {
 	const spinner = clack.spinner();
@@ -161,14 +160,12 @@ if (group.install) {
 	await installDependencies(targetPath);
 	spinner.stop(pc.green("Dependencies installed!"));
 }
-clack.outro(`
-${pc.green("✓")} Project created successfully!
+clack.outro(`${pc.green("✓")} Project created successfully!
 
 ${pc.cyan("Next steps:")}
   ${pc.dim("cd")} ${group.name}
   ${group.install ? "" : `${pc.dim("npm install")}\n  `}${pc.dim("npm run dev")}
 
-Enjoy coding! 🎉
-  `);
+Enjoy coding! 🎉`);
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-mcp-kit",
-  "version": "0.0.6",
-  "description": "create mcp tool kit",
+  "version": "0.0.8",
+  "description": "A CLI tool to create MCP (Model Context Protocol) applications with ease.",
   "type": "module",
   "author": "zhensherlock",
   "homepage": "https://github.com/my-mcp-hub/mcp-kit/tree/master/packages/create#readme",
@@ -12,11 +12,16 @@
     "mcp",
     "mcp server",
     "mcp client",
+    "mcp host",
     "mcp kit",
     "mcp tool kit",
+    "mcp cli",
+    "cli",
+    "cli tool",
     "create mcp",
     "create mcp server",
     "create mcp client",
+    "create mcp host",
     "modelcontextprotocol",
     "typescript"
   ],
@@ -43,7 +48,7 @@
     "gradient-string": "^3.0.0",
     "handlebars": "^4.7.8",
     "picocolors": "^1.1.1",
-    "@mcp-tool-kit/shared": "^0.0.7"
+    "@mcp-tool-kit/shared": "^0.0.9"
   },
   "devDependencies": {},
   "scripts": {

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

@@ -0,0 +1,112 @@
+.DS_Store
+.idea/
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+#.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+/docs/.vitepress/cache/
+
+stats.html
+
+build/

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

@@ -0,0 +1 @@
+v22

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

@@ -0,0 +1,13 @@
+{{#if (includes plugins 'style')}}
+{
+  "tabWidth": 2,
+  "printWidth": 120,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "avoid"
+}
+{{/if}}

package/template/client-js/LICENSE.hbs

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/template/client-js/_github/workflows/build.yml.hbs

@@ -0,0 +1,39 @@
+{{#if (includes plugins 'github-action')}}
+name: build
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    if: github.repository == '{{projectName}}'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install Package
+        run: npm i
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build Package
+        run: npm run build
+
+      - name: Test Package
+        run: npm run coverage
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+{{/if}}