SmartLead MCP TypeScript Standards

📝 SmartLead TypeScript Standards & Best Practices

Code Quality Guide: Master TypeScript patterns and standards used in the SmartLead MCP Server. Write clean, type-safe, maintainable code that follows our established conventions.

🎯 Quick Reference

🔥 Core Principles

1. Strict Type Safety → No any types, use proper interfaces
2. Zod Integration → All inputs validated with Zod schemas
3. Error Handling → Use SmartLeadError for API errors
4. Async Patterns → Consistent async/await usage
5. Documentation → JSDoc for public APIs

⚡ Quick Checklist

• No any types used
• Zod schemas for validation
• Proper error handling
• JSDoc for public methods
• Consistent naming conventions

SmartLead MCP Server - TypeScript Standards

🎯 TypeScript Configuration

Compiler Settings (tsconfig.json)

The project uses strict TypeScript configuration defined in tsconfig.json:

• Target: ES2022 for modern JavaScript features
• Module: ESNext with bundler resolution for optimal tree-shaking
• Strict Mode: All strict options enabled for maximum type safety
• JSX: React JSX for the installer components in src/installer.tsx

Key Compiler Options

{
  "strict": true,
  "noImplicitAny": true,
  "strictNullChecks": true,
  "noImplicitReturns": true,
  "noFallthroughCasesInSwitch": true,
  "noUncheckedIndexedAccess": true,
  "useUnknownInCatchVariables": true
}

📝 Type Definition Patterns

Global Types (src/types.ts)

All shared types and Zod schemas are defined in src/types.ts:

// Zod schema with TypeScript type inference
const CreateCampaignSchema = z.object({
  name: z.string(),
  from_email: z.string().email(),
  // ... other fields
});

// Inferred TypeScript type
type CreateCampaignRequest = z.infer<typeof CreateCampaignSchema>;

Module-Specific Types

Each module can define its own types when needed:

// In src/modules/campaigns/client.ts
interface CampaignResponse {
  id: number;
  name: string;
  status: 'active' | 'paused' | 'completed';
  created_at: string;
}