Merge pull request #170 from QuantGeekDev/feat/create-current-dir-78

QuantGeekDev · web-flow · commit 199339437ea5 · 2026-04-02T13:14:55.000+01:00
feat: support `mcp create .` to scaffold in current directory
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -47,7 +47,7 @@ program.command('build').description('Build the MCP project').action(buildFramew
 program
   .command('create')
   .description('Create a new MCP server project')
-  .argument('[name]', 'project name')
+  .argument('[name]', 'project name (use "." for current directory)')
   .option('--http', 'use HTTP transport instead of default stdio')
   .option('--cors', 'enable CORS with wildcard (*) access')
   .option('--port <number>', 'specify HTTP port (only valid with --http)', (val) =>
diff --git a/src/cli/project/create.ts b/src/cli/project/create.ts
@@ -1,7 +1,8 @@
 import { createRequire } from 'module';
 import { spawnSync } from 'child_process';
-import { mkdir, writeFile } from 'fs/promises';
-import { join } from 'path';
+import { existsSync } from 'fs';
+import { mkdir, readdir, writeFile } from 'fs/promises';
+import { basename, join } from 'path';
 import prompts from 'prompts';
 import { generateReadme } from '../templates/readme.js';
 import { execa } from 'execa';
@@ -49,17 +50,46 @@ export async function createProject(
     projectName = name;
   }
 
+  const isCurrentDir = name === '.';
+
+  if (isCurrentDir) {
+    // Derive project name from current directory name
+    projectName = basename(process.cwd())
+      .toLowerCase()
+      .replace(/[^a-z0-9-]/g, '-')
+      .replace(/^-+|-+$/g, '')
+      .replace(/-{2,}/g, '-');
+
+    if (!projectName) {
+      console.error('❌ Error: Could not derive a valid project name from the current directory name');
+      console.error('   Please rename the directory or specify a project name: mcp create <name>');
+      process.exit(1);
+    }
+  }
+
   if (!projectName) {
     throw new Error('Project name is required');
   }
 
-  const projectDir = join(process.cwd(), projectName);
+  const projectDir = isCurrentDir ? process.cwd() : join(process.cwd(), projectName);
   const srcDir = join(projectDir, 'src');
   const toolsDir = join(srcDir, 'tools');
 
   try {
+    if (isCurrentDir) {
+      const entries = await readdir(projectDir);
+      const conflicts = ['package.json', 'tsconfig.json', 'src'].filter(f => entries.includes(f));
+      if (conflicts.length > 0) {
+        console.error(`❌ Error: Current directory already contains: ${conflicts.join(', ')}`);
+        console.error('   Please use an empty directory or specify a project name: mcp create <name>');
+        process.exit(1);
+      }
+    }
+
     console.log('Creating project structure...');
-    await mkdir(projectDir);
+    if (!isCurrentDir) {
+      await mkdir(projectDir);
+    }
     await mkdir(srcDir);
     await mkdir(toolsDir);
 
@@ -321,14 +351,16 @@ OAUTH_ISSUER=https://auth.example.com
 
     process.chdir(projectDir);
 
-    console.log('Initializing git repository...');
-    const gitInit = spawnSync('git', ['init'], {
-      stdio: 'inherit',
-      shell: true,
-    });
+    if (!isCurrentDir || !existsSync(join(projectDir, '.git'))) {
+      console.log('Initializing git repository...');
+      const gitInit = spawnSync('git', ['init'], {
+        stdio: 'inherit',
+        shell: true,
+      });
 
-    if (gitInit.status !== 0) {
-      throw new Error('Failed to initialize git repository');
+      if (gitInit.status !== 0) {
+        throw new Error('Failed to initialize git repository');
+      }
     }
 
     if (shouldInstall) {
@@ -370,10 +402,12 @@ OAUTH_ISSUER=https://auth.example.com
 ✅ Project ${projectName} created and built successfully with OAuth 2.1!
 
 🔐 OAuth Setup Required:
-1. cd ${projectName}
+${isCurrentDir ? `1. Copy .env.example to .env
+2. Configure your OAuth provider settings in .env
+3. See docs/OAUTH.md for provider-specific setup guides` : `1. cd ${projectName}
 2. Copy .env.example to .env
 3. Configure your OAuth provider settings in .env
-4. See docs/OAUTH.md for provider-specific setup guides
+4. See docs/OAUTH.md for provider-specific setup guides`}
 
 📖 OAuth Resources:
    - Framework docs: https://github.com/QuantGeekDev/mcp-framework/blob/main/docs/OAUTH.md
@@ -385,11 +419,13 @@ OAUTH_ISSUER=https://auth.example.com
       } else {
         console.log(`
 Project ${projectName} created and built successfully!
-
+${isCurrentDir ? `
+Add more tools using:
+   mcp add tool <n>` : `
 You can now:
 1. cd ${projectName}
 2. Add more tools using:
-   mcp add tool <n>
+   mcp add tool <n>`}
     `);
       }
     } else {
@@ -398,26 +434,35 @@ You can now:
 ✅ Project ${projectName} created successfully with OAuth 2.1 (without dependencies)!
 
 Next steps:
-1. cd ${projectName}
+${isCurrentDir ? `1. Copy .env.example to .env
+2. Configure your OAuth provider settings in .env
+3. Run 'npm install' to install dependencies
+4. Run 'npm run build' to build the project
+5. See docs/OAUTH.md for OAuth setup guides` : `1. cd ${projectName}
 2. Copy .env.example to .env
 3. Configure your OAuth provider settings in .env
 4. Run 'npm install' to install dependencies
 5. Run 'npm run build' to build the project
-6. See docs/OAUTH.md for OAuth setup guides
+6. See docs/OAUTH.md for OAuth setup guides`}
 
 🛠️  Add more tools:
    mcp add tool <tool-name>
     `);
       } else {
         console.log(`
 Project ${projectName} created successfully (without dependencies)!
-
+${isCurrentDir ? `
+Next steps:
+1. Run 'npm install' to install dependencies
+2. Run 'npm run build' to build the project
+3. Add more tools using:
+   mcp add tool <n>` : `
 You can now:
 1. cd ${projectName}
 2. Run 'npm install' to install dependencies
 3. Run 'npm run build' to build the project
 4. Add more tools using:
-   mcp add tool <n>
+   mcp add tool <n>`}
     `);
       }
     }
diff --git a/tests/cli/create-current-dir.test.ts b/tests/cli/create-current-dir.test.ts
@@ -0,0 +1,225 @@
+import { describe, it, expect, beforeEach, afterEach, jest } from '@jest/globals';
+import { mkdtempSync, mkdirSync, rmSync, existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import { tmpdir } from 'os';
+import { spawnSync } from 'child_process';
+
+import { createProject } from '../../src/cli/project/create.js';
+
+describe('mcp create . (current directory)', () => {
+  let tempDir: string;
+  const originalCwd = process.cwd();
+  const originalExit = process.exit;
+
+  beforeEach(() => {
+    tempDir = mkdtempSync(join(tmpdir(), 'mcp-test-'));
+  });
+
+  afterEach(() => {
+    process.chdir(originalCwd);
+    process.exit = originalExit;
+    rmSync(tempDir, { recursive: true, force: true });
+  });
+
+  function mockProcessExit(): { getExitCode: () => number | undefined } {
+    let exitCode: number | undefined;
+    process.exit = ((code?: number) => {
+      exitCode = code;
+      throw new Error('process.exit called');
+    }) as never;
+    return { getExitCode: () => exitCode };
+  }
+
+  describe('scaffolding', () => {
+    it('should create all project files in the current directory', async () => {
+      const projectDir = join(tempDir, 'my-test-server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: true });
+
+      expect(existsSync(join(projectDir, 'package.json'))).toBe(true);
+      expect(existsSync(join(projectDir, 'tsconfig.json'))).toBe(true);
+      expect(existsSync(join(projectDir, 'src', 'index.ts'))).toBe(true);
+      expect(existsSync(join(projectDir, 'src', 'tools', 'ExampleTool.ts'))).toBe(true);
+      expect(existsSync(join(projectDir, '.gitignore'))).toBe(true);
+      expect(existsSync(join(projectDir, 'README.md'))).toBe(true);
+    });
+
+    it('should not create a subdirectory', async () => {
+      const projectDir = join(tempDir, 'test-server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      // No nested subdirectory should exist with the project name
+      expect(existsSync(join(projectDir, 'test-server'))).toBe(false);
+    });
+
+    it('should skip example tool when --no-example is used', async () => {
+      const projectDir = join(tempDir, 'no-example');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      expect(existsSync(join(projectDir, 'src', 'tools', 'ExampleTool.ts'))).toBe(false);
+      expect(existsSync(join(projectDir, 'src', 'index.ts'))).toBe(true);
+    });
+
+    it('should generate HTTP transport config when --http is used', async () => {
+      const projectDir = join(tempDir, 'http-server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, http: true, port: 3000 });
+
+      const indexTs = readFileSync(join(projectDir, 'src', 'index.ts'), 'utf-8');
+      expect(indexTs).toContain('http-stream');
+      expect(indexTs).toContain('3000');
+    });
+  });
+
+  describe('project name derivation', () => {
+    it('should derive name from directory name', async () => {
+      const projectDir = join(tempDir, 'my-test-server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      const pkg = JSON.parse(readFileSync(join(projectDir, 'package.json'), 'utf-8'));
+      expect(pkg.name).toBe('my-test-server');
+      expect(pkg.description).toBe('my-test-server MCP server');
+      expect(pkg.bin['my-test-server']).toBe('./dist/index.js');
+    });
+
+    it('should lowercase uppercase directory names', async () => {
+      const projectDir = join(tempDir, 'MyServer');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      const pkg = JSON.parse(readFileSync(join(projectDir, 'package.json'), 'utf-8'));
+      expect(pkg.name).toBe('myserver');
+    });
+
+    it('should replace special characters with hyphens', async () => {
+      const projectDir = join(tempDir, 'My_Cool.Server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      const pkg = JSON.parse(readFileSync(join(projectDir, 'package.json'), 'utf-8'));
+      expect(pkg.name).toBe('my-cool-server');
+    });
+
+    it('should collapse consecutive hyphens', async () => {
+      const projectDir = join(tempDir, 'my___server');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      const pkg = JSON.parse(readFileSync(join(projectDir, 'package.json'), 'utf-8'));
+      expect(pkg.name).toBe('my-server');
+    });
+
+    it('should strip leading and trailing hyphens', async () => {
+      const projectDir = join(tempDir, '-my-server-');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      const pkg = JSON.parse(readFileSync(join(projectDir, 'package.json'), 'utf-8'));
+      expect(pkg.name).toBe('my-server');
+    });
+  });
+
+  describe('conflict detection', () => {
+    it('should reject when package.json exists', async () => {
+      const projectDir = join(tempDir, 'has-pkg');
+      mkdirSync(projectDir);
+      writeFileSync(join(projectDir, 'package.json'), '{}');
+      process.chdir(projectDir);
+
+      const { getExitCode } = mockProcessExit();
+
+      await expect(createProject('.', { install: false })).rejects.toThrow('process.exit called');
+      expect(getExitCode()).toBe(1);
+    });
+
+    it('should reject when tsconfig.json exists', async () => {
+      const projectDir = join(tempDir, 'has-tsconfig');
+      mkdirSync(projectDir);
+      writeFileSync(join(projectDir, 'tsconfig.json'), '{}');
+      process.chdir(projectDir);
+
+      const { getExitCode } = mockProcessExit();
+
+      await expect(createProject('.', { install: false })).rejects.toThrow('process.exit called');
+      expect(getExitCode()).toBe(1);
+    });
+
+    it('should reject when src directory exists', async () => {
+      const projectDir = join(tempDir, 'has-src');
+      mkdirSync(projectDir);
+      mkdirSync(join(projectDir, 'src'));
+      process.chdir(projectDir);
+
+      const { getExitCode } = mockProcessExit();
+
+      await expect(createProject('.', { install: false })).rejects.toThrow('process.exit called');
+      expect(getExitCode()).toBe(1);
+    });
+
+    it('should allow directories with other non-conflicting files', async () => {
+      const projectDir = join(tempDir, 'has-readme');
+      mkdirSync(projectDir);
+      writeFileSync(join(projectDir, 'notes.txt'), 'hello');
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      expect(existsSync(join(projectDir, 'package.json'))).toBe(true);
+    });
+  });
+
+  describe('git init behavior', () => {
+    it('should skip git init when .git already exists', async () => {
+      const projectDir = join(tempDir, 'git-exists');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      // Initialize a git repo before running create
+      spawnSync('git', ['init'], { cwd: projectDir, stdio: 'ignore' });
+      expect(existsSync(join(projectDir, '.git'))).toBe(true);
+
+      // Capture console output to verify git init was skipped
+      const logs: string[] = [];
+      const originalLog = console.log;
+      console.log = (...args: unknown[]) => logs.push(args.join(' '));
+
+      await createProject('.', { install: false, example: false });
+
+      console.log = originalLog;
+
+      expect(logs.some((l) => l.includes('Initializing git'))).toBe(false);
+      expect(existsSync(join(projectDir, 'package.json'))).toBe(true);
+    });
+
+    it('should run git init when no .git exists', async () => {
+      const projectDir = join(tempDir, 'no-git');
+      mkdirSync(projectDir);
+      process.chdir(projectDir);
+
+      await createProject('.', { install: false, example: false });
+
+      expect(existsSync(join(projectDir, '.git'))).toBe(true);
+    });
+  });
+});
