diff --git a/package.json b/package.json index ff9d381..2cfcc92 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@agentailor/create-mcp-server", - "version": "0.5.0", + "version": "0.5.1", "description": "Create a new MCP (Model Context Protocol) server project", "type": "module", "bin": { diff --git a/src/templates/fastmcp/readme.ts b/src/templates/fastmcp/readme.ts index c5513be..c34586c 100644 --- a/src/templates/fastmcp/readme.ts +++ b/src/templates/fastmcp/readme.ts @@ -4,10 +4,31 @@ export function getReadmeTemplate(projectName: string, options?: TemplateOptions const packageManager = options?.packageManager ?? 'npm'; const stateless = options?.stateless ?? false; - const commands: Record = { - npm: { install: 'npm install', dev: 'npm run dev', build: 'npm run build', start: 'npm start' }, - pnpm: { install: 'pnpm install', dev: 'pnpm dev', build: 'pnpm build', start: 'pnpm start' }, - yarn: { install: 'yarn', dev: 'yarn dev', build: 'yarn build', start: 'yarn start' }, + const commands: Record< + string, + { install: string; dev: string; build: string; start: string; inspect: string } + > = { + npm: { + install: 'npm install', + dev: 'npm run dev', + build: 'npm run build', + start: 'npm start', + inspect: 'npm run inspect', + }, + pnpm: { + install: 'pnpm install', + dev: 'pnpm dev', + build: 'pnpm build', + start: 'pnpm start', + inspect: 'pnpm inspect', + }, + yarn: { + install: 'yarn', + dev: 'yarn dev', + build: 'yarn build', + start: 'yarn start', + inspect: 'yarn inspect', + }, }; const cmd = commands[packageManager]; @@ -40,6 +61,22 @@ ${cmd.start} The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable. +## Testing with MCP Inspector + +This project includes [MCP Inspector](https://github.com/modelcontextprotocol/inspector) as a dev dependency for testing and debugging. + +First, start the server in one terminal: + +\`\`\`bash +${cmd.dev} +\`\`\` + +Then, in another terminal, launch the inspector: + +\`\`\`bash +${cmd.inspect} +\`\`\` + ## API Endpoints - **POST /mcp** - Main MCP endpoint for JSON-RPC messages diff --git a/src/templates/sdk/stateful/readme.ts b/src/templates/sdk/stateful/readme.ts index 3e8e9dc..aa0fcfd 100644 --- a/src/templates/sdk/stateful/readme.ts +++ b/src/templates/sdk/stateful/readme.ts @@ -5,9 +5,27 @@ export function getReadmeTemplate(projectName: string, options?: TemplateOptions const packageManager = options?.packageManager ?? 'npm'; const commands = { - npm: { install: 'npm install', dev: 'npm run dev', build: 'npm run build', start: 'npm start' }, - pnpm: { install: 'pnpm install', dev: 'pnpm dev', build: 'pnpm build', start: 'pnpm start' }, - yarn: { install: 'yarn', dev: 'yarn dev', build: 'yarn build', start: 'yarn start' }, + npm: { + install: 'npm install', + dev: 'npm run dev', + build: 'npm run build', + start: 'npm start', + inspect: 'npm run inspect', + }, + pnpm: { + install: 'pnpm install', + dev: 'pnpm dev', + build: 'pnpm build', + start: 'pnpm start', + inspect: 'pnpm inspect', + }, + yarn: { + install: 'yarn', + dev: 'yarn dev', + build: 'yarn build', + start: 'yarn start', + inspect: 'yarn inspect', + }, }[packageManager]; const description = withOAuth @@ -126,6 +144,22 @@ ${commands.start} \`\`\` The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable. + +## Testing with MCP Inspector + +This project includes [MCP Inspector](https://github.com/modelcontextprotocol/inspector) as a dev dependency for testing and debugging. + +First, start the server in one terminal: + +\`\`\`bash +${commands.dev} +\`\`\` + +Then, in another terminal, launch the inspector: + +\`\`\`bash +${commands.inspect} +\`\`\` ${oauthSection} ## API Endpoints diff --git a/src/templates/sdk/stateless/readme.ts b/src/templates/sdk/stateless/readme.ts index cf2436f..cd711fd 100644 --- a/src/templates/sdk/stateless/readme.ts +++ b/src/templates/sdk/stateless/readme.ts @@ -4,9 +4,27 @@ export function getReadmeTemplate(projectName: string, options?: TemplateOptions const packageManager = options?.packageManager ?? 'npm'; const commands = { - npm: { install: 'npm install', dev: 'npm run dev', build: 'npm run build', start: 'npm start' }, - pnpm: { install: 'pnpm install', dev: 'pnpm dev', build: 'pnpm build', start: 'pnpm start' }, - yarn: { install: 'yarn', dev: 'yarn dev', build: 'yarn build', start: 'yarn start' }, + npm: { + install: 'npm install', + dev: 'npm run dev', + build: 'npm run build', + start: 'npm start', + inspect: 'npm run inspect', + }, + pnpm: { + install: 'pnpm install', + dev: 'pnpm dev', + build: 'pnpm build', + start: 'pnpm start', + inspect: 'pnpm inspect', + }, + yarn: { + install: 'yarn', + dev: 'yarn dev', + build: 'yarn build', + start: 'yarn start', + inspect: 'yarn inspect', + }, }[packageManager]; return `# ${projectName} @@ -33,6 +51,22 @@ ${commands.start} The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable. +## Testing with MCP Inspector + +This project includes [MCP Inspector](https://github.com/modelcontextprotocol/inspector) as a dev dependency for testing and debugging. + +First, start the server in one terminal: + +\`\`\`bash +${commands.dev} +\`\`\` + +Then, in another terminal, launch the inspector: + +\`\`\`bash +${commands.inspect} +\`\`\` + ## API Endpoints - **POST /mcp** - Main MCP endpoint for JSON-RPC messages