@agentailor/create-mcp-server 0.1.0 → 0.2.1

package/dist/templates/stateful-streamable-http/auth.test.js

@@ -0,0 +1,100 @@
+import { describe, it, expect } from 'vitest';
+import { getAuthTemplate } from './auth.js';
+describe('auth template', () => {
+    describe('getAuthTemplate', () => {
+        it('should include OAuth configuration from environment variables', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('OAUTH_ISSUER_URL');
+            expect(template).toContain('OAUTH_AUDIENCE');
+        });
+        it('should include dotenv import', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain("import 'dotenv/config'");
+        });
+        it('should import jose for JWT verification', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain("from 'jose'");
+            expect(template).toContain('createRemoteJWKSet');
+            expect(template).toContain('jwtVerify');
+        });
+        it('should use SDK auth imports', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain("from '@modelcontextprotocol/sdk/server/auth/router.js'");
+            expect(template).toContain("from '@modelcontextprotocol/sdk/server/auth/middleware/bearerAuth.js'");
+            expect(template).toContain("from '@modelcontextprotocol/sdk/shared/auth.js'");
+        });
+        it('should export setupAuthMetadataRouter function', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('export function setupAuthMetadataRouter');
+            expect(template).toContain('mcpAuthMetadataRouter');
+        });
+        it('should export authMiddleware', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('export const authMiddleware');
+            expect(template).toContain('requireBearerAuth');
+        });
+        it('should export getOAuthMetadataUrl helper', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('export function getOAuthMetadataUrl');
+            expect(template).toContain('getOAuthProtectedResourceMetadataUrl');
+        });
+        it('should include token verifier using JWKS/JWT', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('tokenVerifier');
+            expect(template).toContain('verifyAccessToken');
+            expect(template).toContain('jwtVerify(token, JWKS');
+        });
+        it('should create remote JWKS from discovery document jwks_uri', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('createRemoteJWKSet');
+            expect(template).toContain('discovery.jwks_uri');
+            expect(template).toContain('JWKS = createRemoteJWKSet');
+        });
+        it('should validate issuer and audience claims', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('issuer:');
+            expect(template).toContain('audience:');
+        });
+        it('should use Express types', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain("from 'express'");
+            expect(template).toContain('Express');
+            expect(template).toContain('RequestHandler');
+        });
+        it('should export validateOAuthConfig function', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('export async function validateOAuthConfig');
+        });
+        it('should check well-known endpoint for OAuth server availability', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('.well-known/openid-configuration');
+        });
+        it('should throw detailed error when OIDC discovery fails', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('Failed to fetch OIDC discovery document');
+            expect(template).toContain('OAUTH_ISSUER_URL environment variable');
+            expect(template).toContain('OAuth server is running and accessible');
+        });
+        it('should fetch OAuth metadata from OIDC discovery endpoint', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('OIDCDiscoveryDocument');
+            expect(template).toContain('authorization_endpoint');
+            expect(template).toContain('token_endpoint');
+            expect(template).toContain('oauthMetadata = {');
+        });
+        it('should use timeout for OAuth server validation requests', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('AbortSignal.timeout(5000)');
+        });
+        it('should extract client ID from JWT claims', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain('azp');
+            expect(template).toContain('client_id');
+            expect(template).toContain('sub');
+        });
+        it('should extract scopes from JWT scope claim', () => {
+            const template = getAuthTemplate();
+            expect(template).toContain("jwtPayload.scope.split(' ')");
+        });
+    });
+});

package/dist/templates/stateful-streamable-http/index.d.ts

@@ -1,3 +1,8 @@
-export declare function getIndexTemplate(): string;
+export interface TemplateOptions {
+    withOAuth?: boolean;
+    packageManager?: 'npm' | 'pnpm' | 'yarn';
+}
+export declare function getIndexTemplate(options?: TemplateOptions): string;
 export { getServerTemplate } from './server.js';
 export { getReadmeTemplate } from './readme.js';
+export { getAuthTemplate } from './auth.js';

package/dist/templates/stateful-streamable-http/index.js

@@ -1,17 +1,42 @@
-export function getIndexTemplate() {
-    return `import { type Request, type Response } from 'express';
+export function getIndexTemplate(options) {
+    const withOAuth = options?.withOAuth ?? false;
+    const imports = withOAuth
+        ? `import { type Request, type Response } from 'express';
 import { randomUUID } from 'node:crypto';
 import { createMcpExpressApp } from '@modelcontextprotocol/sdk/server/express.js';
 import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
 import { isInitializeRequest } from '@modelcontextprotocol/sdk/types.js';
 import { getServer } from './server.js';
-
-const app = createMcpExpressApp();
+import {
+  setupAuthMetadataRouter,
+  authMiddleware,
+  getOAuthMetadataUrl,
+  validateOAuthConfig,
+} from './auth.js';`
+        : `import { type Request, type Response } from 'express';
+import { randomUUID } from 'node:crypto';
+import { createMcpExpressApp } from '@modelcontextprotocol/sdk/server/express.js';
+import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
+import { isInitializeRequest } from '@modelcontextprotocol/sdk/types.js';
+import { getServer } from './server.js';`;
+    const appSetup = `const app = createMcpExpressApp();`;
+    const postRoute = withOAuth
+        ? `app.post('/mcp', authMiddleware, async (req: Request, res: Response) => {`
+        : `app.post('/mcp', async (req: Request, res: Response) => {`;
+    const getRoute = withOAuth
+        ? `app.get('/mcp', authMiddleware, async (req: Request, res: Response) => {`
+        : `app.get('/mcp', async (req: Request, res: Response) => {`;
+    const deleteRoute = withOAuth
+        ? `app.delete('/mcp', authMiddleware, async (req: Request, res: Response) => {`
+        : `app.delete('/mcp', async (req: Request, res: Response) => {`;
+    return `${imports}
+
+${appSetup}
 
 // Map to store transports by session ID
 const transports: { [sessionId: string]: StreamableHTTPServerTransport } = {};
 
-app.post('/mcp', async (req: Request, res: Response) => {
+${postRoute}
   const sessionId = req.headers['mcp-session-id'] as string | undefined;
   if (sessionId) {
     console.log(\`Received MCP request for session: \${sessionId}\`);
@@ -79,7 +104,7 @@ app.post('/mcp', async (req: Request, res: Response) => {
   }
 });
 
-app.get('/mcp', async (req: Request, res: Response) => {
+${getRoute}
   const sessionId = req.headers['mcp-session-id'] as string | undefined;
   if (!sessionId || !transports[sessionId]) {
     res.status(400).send('Invalid or missing session ID');
@@ -91,7 +116,7 @@ app.get('/mcp', async (req: Request, res: Response) => {
   await transport.handleRequest(req, res);
 });
 
-app.delete('/mcp', async (req: Request, res: Response) => {
+${deleteRoute}
   const sessionId = req.headers['mcp-session-id'] as string | undefined;
   if (!sessionId || !transports[sessionId]) {
     res.status(400).send('Invalid or missing session ID');
@@ -111,11 +136,63 @@ app.delete('/mcp', async (req: Request, res: Response) => {
   }
 });
 
-// Start the server
+${withOAuth
+        ? `// Start the server
 const PORT = process.env.PORT || 3000;
-app.listen(PORT, () => {
-  console.log(\`MCP Stateful HTTP Server listening on port \${PORT}\`);
-});
+
+function startServer(port: number | string): void {
+  const server = app.listen(port, () => {
+    console.log(\`MCP Stateful HTTP Server listening on port \${port}\`);
+    console.log(\`OAuth metadata available at \${getOAuthMetadataUrl()}\`);
+  });
+
+  server.on('error', (error: NodeJS.ErrnoException) => {
+    if (error.code === 'EADDRINUSE') {
+      const randomPort = Math.floor(Math.random() * (65535 - 49152) + 49152);
+      console.log(\`Port \${port} is in use, trying port \${randomPort}...\`);
+      startServer(randomPort);
+    } else {
+      console.error('Failed to start server:', error);
+      process.exit(1);
+    }
+  });
+}
+
+async function main() {
+  // Validate OAuth configuration and fetch OIDC discovery document
+  await validateOAuthConfig();
+
+  // Setup OAuth metadata routes (must be after validateOAuthConfig)
+  setupAuthMetadataRouter(app);
+
+  startServer(PORT);
+}
+
+main().catch((error) => {
+  console.error('Failed to start server:', error.message);
+  process.exit(1);
+});`
+        : `// Start the server
+const PORT = process.env.PORT || 3000;
+
+function startServer(port: number | string): void {
+  const server = app.listen(port, () => {
+    console.log(\`MCP Stateful HTTP Server listening on port \${port}\`);
+  });
+
+  server.on('error', (error: NodeJS.ErrnoException) => {
+    if (error.code === 'EADDRINUSE') {
+      const randomPort = Math.floor(Math.random() * (65535 - 49152) + 49152);
+      console.log(\`Port \${port} is in use, trying port \${randomPort}...\`);
+      startServer(randomPort);
+    } else {
+      console.error('Failed to start server:', error);
+      process.exit(1);
+    }
+  });
+}
+
+startServer(PORT);`}
 
 // Handle server shutdown
 process.on('SIGINT', async () => {
@@ -138,3 +215,4 @@ process.on('SIGINT', async () => {
 }
 export { getServerTemplate } from './server.js';
 export { getReadmeTemplate } from './readme.js';
+export { getAuthTemplate } from './auth.js';

package/dist/templates/stateful-streamable-http/readme.d.ts

@@ -1 +1,2 @@
-export declare function getReadmeTemplate(projectName: string): string;
+import type { TemplateOptions } from './index.js';
+export declare function getReadmeTemplate(projectName: string, options?: TemplateOptions): string;

package/dist/templates/stateful-streamable-http/readme.js

@@ -1,7 +1,87 @@
-export function getReadmeTemplate(projectName) {
+export function getReadmeTemplate(projectName, options) {
+    const withOAuth = options?.withOAuth ?? false;
+    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' },
+    }[packageManager];
+    const description = withOAuth
+        ? 'A stateful streamable HTTP MCP (Model Context Protocol) server with session management and OAuth authentication.'
+        : 'A stateful streamable HTTP MCP (Model Context Protocol) server with session management.';
+    const oauthSection = withOAuth
+        ? `
+## OAuth Authentication
+
+This server uses OAuth 2.0 with JWT tokens for authentication. It works with any OIDC-compliant provider including:
+- Auth0
+- Keycloak
+- Azure AD / Entra ID
+- Okta
+- And more...
+
+### Environment Variables
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| \`OAUTH_ISSUER_URL\` | Base URL of your OAuth provider | \`https://your-tenant.auth0.com\` |
+| \`OAUTH_AUDIENCE\` | API identifier / audience claim (optional) | \`https://your-api.com\` |
+
+### Provider-Specific Issuer URLs
+
+| Provider | Issuer URL Format |
+|----------|-------------------|
+| Auth0 | \`https://{tenant}.auth0.com\` |
+| Keycloak | \`http://{host}:{port}/realms/{realm}\` |
+| Azure AD | \`https://login.microsoftonline.com/{tenant}/v2.0\` |
+| Okta | \`https://{domain}.okta.com/oauth2/default\` |
+
+### How It Works
+
+1. The server fetches public keys from \`{OAUTH_ISSUER_URL}/.well-known/jwks.json\`
+2. Incoming JWT tokens are verified locally using these keys
+3. The token's \`iss\` (issuer) and optionally \`aud\` (audience) claims are validated
+
+### Protected Resource Metadata
+
+- **GET /.well-known/oauth-protected-resource** - OAuth protected resource metadata
+
+### Token Requirements
+
+- All MCP endpoints require a valid JWT Bearer token in the \`Authorization\` header
+- Tokens must be signed by the configured OAuth provider
+- If \`OAUTH_AUDIENCE\` is set, the token's \`aud\` claim must match
+`
+        : '';
+    const apiEndpointsOAuthNote = withOAuth
+        ? '\n  - Requires valid Bearer token in Authorization header'
+        : '';
+    const projectStructure = withOAuth
+        ? `\`\`\`
+${projectName}/
+├── src/
+│   ├── server.ts     # MCP server definition (tools, prompts, resources)
+│   ├── index.ts      # Express app and stateful HTTP transport setup
+│   └── auth.ts       # OAuth configuration and middleware
+├── package.json
+├── tsconfig.json
+└── README.md
+\`\`\``
+        : `\`\`\`
+${projectName}/
+├── src/
+│   ├── server.ts     # MCP server definition (tools, prompts, resources)
+│   └── index.ts      # Express app and stateful HTTP transport setup
+├── package.json
+├── tsconfig.json
+└── README.md
+\`\`\``;
+    const customizationOAuthNote = withOAuth
+        ? '\n- Configure OAuth scopes and token verification in `src/auth.ts`'
+        : '';
     return `# ${projectName}
 
-A stateful streamable HTTP MCP (Model Context Protocol) server with session management.
+${description}
 
 ## About
 
@@ -11,27 +91,27 @@ This project was created with [@agentailor/create-mcp-server](https://www.npmjs.
 
 \`\`\`bash
 # Install dependencies
-npm install
+${commands.install}
 
 # Build and run in development
-npm run dev
+${commands.dev}
 
 # Or build and start separately
-npm run build
-npm start
+${commands.build}
+${commands.start}
 \`\`\`
 
 The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable.
-
+${oauthSection}
 ## API Endpoints
 
 - **POST /mcp** - Main MCP endpoint for JSON-RPC messages
   - First request must be an initialization request (no session ID required)
-  - Subsequent requests must include \`mcp-session-id\` header
+  - Subsequent requests must include \`mcp-session-id\` header${apiEndpointsOAuthNote}
 - **GET /mcp** - Server-Sent Events (SSE) stream for server-initiated messages
-  - Requires \`mcp-session-id\` header
+  - Requires \`mcp-session-id\` header${apiEndpointsOAuthNote}
 - **DELETE /mcp** - Terminate a session
-  - Requires \`mcp-session-id\` header
+  - Requires \`mcp-session-id\` header${apiEndpointsOAuthNote}
 
 ## Session Management
 
@@ -63,20 +143,12 @@ This server comes with example implementations to help you get started:
 
 ## Project Structure
 
-\`\`\`
-${projectName}/
-├── src/
-│   ├── server.ts     # MCP server definition (tools, prompts, resources)
-│   └── index.ts      # Express app and stateful HTTP transport setup
-├── package.json
-├── tsconfig.json
-└── README.md
-\`\`\`
+${projectStructure}
 
 ## Customization
 
 - Add new tools, prompts, and resources in \`src/server.ts\`
-- Modify the HTTP transport configuration in \`src/index.ts\`
+- Modify the HTTP transport configuration in \`src/index.ts\`${customizationOAuthNote}
 
 ## Learn More
 

package/dist/templates/stateful-streamable-http/templates.test.js

@@ -83,10 +83,12 @@ describe('stateful-streamable-http templates', () => {
             const template = getReadmeTemplate(projectName);
             expect(template).toContain(`# ${projectName}`);
         });
-        it('should include getting started instructions', () => {
+        it('should include getting started instructions with npm by default', () => {
             const template = getReadmeTemplate(projectName);
             expect(template).toContain('npm install');
             expect(template).toContain('npm run dev');
+            expect(template).toContain('npm run build');
+            expect(template).toContain('npm start');
         });
         it('should document the /mcp endpoint', () => {
             const template = getReadmeTemplate(projectName);
@@ -108,4 +110,116 @@ describe('stateful-streamable-http templates', () => {
             expect(template).toContain('DELETE /mcp');
         });
     });
+    describe('getReadmeTemplate with package manager', () => {
+        it('should use npm commands when packageManager is npm', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'npm' });
+            expect(template).toContain('npm install');
+            expect(template).toContain('npm run dev');
+            expect(template).toContain('npm run build');
+            expect(template).toContain('npm start');
+        });
+        it('should use pnpm commands when packageManager is pnpm', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'pnpm' });
+            expect(template).toContain('pnpm install');
+            expect(template).toContain('pnpm dev');
+            expect(template).toContain('pnpm build');
+            expect(template).toContain('pnpm start');
+            expect(template).not.toContain('npm run');
+        });
+        it('should use yarn commands when packageManager is yarn', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'yarn' });
+            expect(template).toContain('yarn\n');
+            expect(template).toContain('yarn dev');
+            expect(template).toContain('yarn build');
+            expect(template).toContain('yarn start');
+            expect(template).not.toContain('npm run');
+        });
+    });
+    describe('getIndexTemplate with OAuth', () => {
+        it('should include auth imports when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain("from './auth.js'");
+            expect(template).toContain('setupAuthMetadataRouter');
+            expect(template).toContain('authMiddleware');
+            expect(template).toContain('getOAuthMetadataUrl');
+        });
+        it('should import validateOAuthConfig when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('validateOAuthConfig');
+        });
+        it('should setup auth metadata router when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('setupAuthMetadataRouter(app)');
+        });
+        it('should apply auth middleware to routes when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain("app.post('/mcp', authMiddleware,");
+            expect(template).toContain("app.get('/mcp', authMiddleware,");
+            expect(template).toContain("app.delete('/mcp', authMiddleware,");
+        });
+        it('should log OAuth metadata URL on startup when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('getOAuthMetadataUrl()');
+        });
+        it('should call validateOAuthConfig before starting server when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('await validateOAuthConfig()');
+        });
+        it('should wrap server startup in async main function when OAuth enabled', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('async function main()');
+            expect(template).toContain('main().catch');
+        });
+        it('should exit with error if OAuth validation fails', () => {
+            const template = getIndexTemplate({ withOAuth: true });
+            expect(template).toContain('Failed to start server');
+            expect(template).toContain('process.exit(1)');
+        });
+        it('should NOT include auth imports when OAuth disabled', () => {
+            const template = getIndexTemplate({ withOAuth: false });
+            expect(template).not.toContain("from './auth.js'");
+            expect(template).not.toContain('authMiddleware');
+        });
+        it('should NOT include auth imports by default', () => {
+            const template = getIndexTemplate();
+            expect(template).not.toContain("from './auth.js'");
+        });
+        it('should NOT wrap in async main when OAuth disabled', () => {
+            const template = getIndexTemplate({ withOAuth: false });
+            expect(template).not.toContain('async function main()');
+        });
+    });
+    describe('getReadmeTemplate with OAuth', () => {
+        it('should include OAuth section when enabled', () => {
+            const template = getReadmeTemplate(projectName, { withOAuth: true });
+            expect(template).toContain('## OAuth Authentication');
+            expect(template).toContain('OAUTH_ISSUER_URL');
+            expect(template).toContain('OAUTH_AUDIENCE');
+            expect(template).toContain('Bearer token');
+        });
+        it('should list supported OAuth providers', () => {
+            const template = getReadmeTemplate(projectName, { withOAuth: true });
+            expect(template).toContain('Auth0');
+            expect(template).toContain('Keycloak');
+            expect(template).toContain('Azure AD');
+            expect(template).toContain('Okta');
+        });
+        it('should document JWKS-based JWT validation', () => {
+            const template = getReadmeTemplate(projectName, { withOAuth: true });
+            expect(template).toContain('JWT');
+            expect(template).toContain('.well-known/jwks.json');
+        });
+        it('should include auth.ts in project structure when OAuth enabled', () => {
+            const template = getReadmeTemplate(projectName, { withOAuth: true });
+            expect(template).toContain('auth.ts');
+        });
+        it('should NOT include OAuth section when disabled', () => {
+            const template = getReadmeTemplate(projectName, { withOAuth: false });
+            expect(template).not.toContain('## OAuth Authentication');
+        });
+        it('should NOT include OAuth section by default', () => {
+            const template = getReadmeTemplate(projectName);
+            expect(template).not.toContain('## OAuth Authentication');
+        });
+    });
 });

package/dist/templates/streamable-http/index.d.ts

@@ -1,3 +1,7 @@
-export declare function getIndexTemplate(): string;
+export interface TemplateOptions {
+    withOAuth?: boolean;
+    packageManager?: 'npm' | 'pnpm' | 'yarn';
+}
+export declare function getIndexTemplate(options?: TemplateOptions): string;
 export { getServerTemplate } from './server.js';
 export { getReadmeTemplate } from './readme.js';

package/dist/templates/streamable-http/index.js

@@ -1,4 +1,6 @@
-export function getIndexTemplate() {
+// Options parameter added for type consistency with stateful template (OAuth not supported in stateless)
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function getIndexTemplate(options) {
     return `import { type Request, type Response } from 'express';
 import { createMcpExpressApp } from '@modelcontextprotocol/sdk/server/express.js';
 import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
@@ -64,13 +66,25 @@ app.delete('/mcp', async (req: Request, res: Response) => {
 
 // Start the server
 const PORT = process.env.PORT || 3000;
-app.listen(PORT, (error) => {
-  if (error) {
-    console.error('Failed to start server:', error);
-    process.exit(1);
-  }
-  console.log(\`MCP Streamable HTTP Server listening on port \${PORT}\`);
-});
+
+function startServer(port: number | string): void {
+  const server = app.listen(port, () => {
+    console.log(\`MCP Streamable HTTP Server listening on port \${port}\`);
+  });
+
+  server.on('error', (error: NodeJS.ErrnoException) => {
+    if (error.code === 'EADDRINUSE') {
+      const randomPort = Math.floor(Math.random() * (65535 - 49152) + 49152);
+      console.log(\`Port \${port} is in use, trying port \${randomPort}...\`);
+      startServer(randomPort);
+    } else {
+      console.error('Failed to start server:', error);
+      process.exit(1);
+    }
+  });
+}
+
+startServer(PORT);
 
 // Handle server shutdown
 process.on('SIGINT', async () => {

package/dist/templates/streamable-http/readme.d.ts

@@ -1 +1,2 @@
-export declare function getReadmeTemplate(projectName: string): string;
+import type { TemplateOptions } from './index.js';
+export declare function getReadmeTemplate(projectName: string, options?: TemplateOptions): string;

package/dist/templates/streamable-http/readme.js

@@ -1,4 +1,10 @@
-export function getReadmeTemplate(projectName) {
+export function getReadmeTemplate(projectName, options) {
+    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' },
+    }[packageManager];
     return `# ${projectName}
 
 A stateless streamable HTTP MCP (Model Context Protocol) server.
@@ -11,14 +17,14 @@ This project was created with [@agentailor/create-mcp-server](https://www.npmjs.
 
 \`\`\`bash
 # Install dependencies
-npm install
+${commands.install}
 
 # Build and run in development
-npm run dev
+${commands.dev}
 
 # Or build and start separately
-npm run build
-npm start
+${commands.build}
+${commands.start}
 \`\`\`
 
 The server will start on port 3000 by default. You can change this by setting the \`PORT\` environment variable.

package/dist/templates/streamable-http/templates.test.js

@@ -63,10 +63,12 @@ describe('streamable-http templates', () => {
             const template = getReadmeTemplate(projectName);
             expect(template).toContain(`# ${projectName}`);
         });
-        it('should include getting started instructions', () => {
+        it('should include getting started instructions with npm by default', () => {
             const template = getReadmeTemplate(projectName);
             expect(template).toContain('npm install');
             expect(template).toContain('npm run dev');
+            expect(template).toContain('npm run build');
+            expect(template).toContain('npm start');
         });
         it('should document the /mcp endpoint', () => {
             const template = getReadmeTemplate(projectName);
@@ -77,4 +79,29 @@ describe('streamable-http templates', () => {
             expect(template).toContain('stateless');
         });
     });
+    describe('getReadmeTemplate with package manager', () => {
+        it('should use npm commands when packageManager is npm', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'npm' });
+            expect(template).toContain('npm install');
+            expect(template).toContain('npm run dev');
+            expect(template).toContain('npm run build');
+            expect(template).toContain('npm start');
+        });
+        it('should use pnpm commands when packageManager is pnpm', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'pnpm' });
+            expect(template).toContain('pnpm install');
+            expect(template).toContain('pnpm dev');
+            expect(template).toContain('pnpm build');
+            expect(template).toContain('pnpm start');
+            expect(template).not.toContain('npm run');
+        });
+        it('should use yarn commands when packageManager is yarn', () => {
+            const template = getReadmeTemplate(projectName, { packageManager: 'yarn' });
+            expect(template).toContain('yarn\n');
+            expect(template).toContain('yarn dev');
+            expect(template).toContain('yarn build');
+            expect(template).toContain('yarn start');
+            expect(template).not.toContain('npm run');
+        });
+    });
 });