Skip to main content

FILE_STRUCTURE

MCP Generator - File Structure

mcp-generator/ │ ├── 📦 Package Configuration │ ├── package.json (Dependencies, scripts, metadata) │ ├── tsconfig.json (TypeScript configuration) │ ├── jest.config.js (Test configuration) │ ├── .gitignore (Git exclusions) │ └── .npmignore (npm exclusions) │ ├── 📖 Documentation │ ├── README.md (Comprehensive user guide) │ ├── QUICKSTART.md (5-minute getting started) │ ├── ARCHITECTURE.md (System design documentation) │ ├── CHANGELOG.md (Version history) │ ├── PROJECT_SUMMARY.md (Project completion summary) │ └── FILE_STRUCTURE.txt (This file) │ ├── 💻 Source Code (src/) │ ├── types.ts (Core type definitions) │ ├── scanner.ts (OpenAPI spec scanner) │ ├── generator.ts (MCP tool generator) │ ├── registry.ts (Registry builder) │ ├── cli.ts (Command-line interface) │ └── index.ts (Main exports) │ ├── 🧪 Tests (tests/) │ ├── scanner.test.ts (Scanner unit tests) │ ├── generator.test.ts (Generator unit tests) │ └── registry.test.ts (Registry unit tests) │ ├── 📚 Examples (examples/) │ ├── basic-usage.ts (Simple scan and generate) │ ├── custom-handler.ts (Custom HTTP implementation) │ └── service-specific.ts (Generate for one service) │ ├── 🏗️ Build Output (dist/) - Generated by npm run build │ ├── *.js (Compiled JavaScript) │ ├── *.d.ts (Type declarations) │ └── *.js.map (Source maps) │ ├── 📁 Generated Output (generated/) - Created by tool │ ├── registry.ts (Complete MCP tool registry) │ ├── registry.json (JSON format registry) │ └── services/ (Per-service tool modules) │ ├── agent-protocol.ts │ ├── agentic-flows.ts │ └── ... │ └── 📦 Dependencies (node_modules/) - Created by npm install └── [All npm packages]

File Count Summary

  • Source Files: 6 TypeScript files
  • Test Files: 3 TypeScript files
  • Example Files: 3 TypeScript files
  • Documentation: 6 Markdown files
  • Configuration: 5 config files
  • Total: 23 files

Lines of Code (Estimated)

  • Source Code: ~1,500 lines
  • Tests: ~500 lines
  • Examples: ~300 lines
  • Documentation: ~1,500 lines
  • Total: ~3,800 lines

Build Commands

npm install # Install dependencies npm run build # Compile TypeScript npm test # Run tests npm run scan # Scan for OpenAPI specs npm run generate # Generate MCP tools

CLI Commands

mcp-gen scan --path <dir> # Scan directory mcp-gen generate --path <dir> --output <dir> # Generate tools mcp-gen list --path <registry> # List tools mcp-gen validate --path <spec> # Validate spec

Status: ✅ PRODUCTION READY Date: 2026-01-29