main-rule

MCP Server Development Guidelines

project name: mcp-server-webscan

memory_bank ProjectID: de83ede7-85de-4746-86c7-c2dafefc3fb7

Description:

A Model Context Protocol (MCP) server for web content scanning and analysis. This server provides tools for fetching, analyzing, and extracting information from web pages.

IMPERATIVE

- All projects must contain a PRD, Features spec, and RFCs
    - All projects must have a memory - bank

Project Structure

- Follow the standard MCP server directory structure:

  src/
  ├── config/
  │   └── ConfigurationManager.ts
  ├── services/
  │   ├── YourService.ts
  │   └── index.ts
  ├── tools/
  │   ├── yourTool.ts
  │   ├── yourToolParams.ts
  │   └── index.ts
  ├── types/
  │   ├── yourServiceTypes.ts
  │   └── index.ts
  ├── utils/
  │   ├── logger.ts
  │   ├── errors.ts
  │   └── index.ts
  ├── initialize.ts
  └── server.ts

TypeScript Standards

- Use ES Modules format with `.js` extensions in imports:

  // Correct:
  import { YourService } from '../services/YourService.js';
  
  // Incorrect:
  import { YourService } from '../services/YourService';

- Enforce strict TypeScript typing(see tsconfig.json)
    - Prefer interfaces over types for object definitions:
        ```typescript

// Preferred: interface UserData { id: string; name: string; }

// Avoid for object shapes: type UserData = { id: string; name: string; };

             *****IMPORTANT DON'T FORGET**** - Use functional programming patterns over class-based patterns where possible
                  - Avoid enums; use string literal unions or constant maps:
```typescript
// Preferred:
type Status = 'pending' | 'processing' | 'complete' | 'error';

// Or:
const STATUS = {
  PENDING: 'pending',
  PROCESSING: 'processing',
  COMPLETE: 'complete',
  ERROR: 'error'
} as const;
type Status = typeof STATUS[keyof typeof STATUS];

// Avoid:
enum Status {
  PENDING = 'pending',
  PROCESSING = 'processing',
  COMPLETE = 'complete',
  ERROR = 'error'
}