Skip to main content
Glama
SourireConcept

CloudZIR MCP Server

README.md
# CloudZIR MCP Server

[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue?logo=typescript)](https://www.typescriptlang.org/)
[![Node.js](https://img.shields.io/badge/Node.js-18+-green?logo=node.js)](https://nodejs.org/)
[![Vercel Ready](https://img.shields.io/badge/Vercel-Ready-black?logo=vercel)](https://vercel.com/)
[![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)

**CloudZIR MCP Server** is a Model Context Protocol (MCP) server implementation with integrated CloudZIR system prompts and context management for enterprise-grade AI applications.

## šŸŽÆ Features

- šŸ¤– **Complete MCP Server Implementation** - Full compliance with Model Context Protocol specification
- šŸŽØ **CloudZIR System Prompts** - Master system prompts for consistent AI behavior
- šŸ—ļø **Enterprise Architecture** - Production-ready, scalable, and secure
- ⚔ **Zero Approximation** - Intelligent automation with strict validation
- šŸ“¦ **TypeScript Ready** - Full type safety and excellent IDE support
- šŸš€ **Vercel Deployment** - One-click deployment to Vercel
- šŸ”’ **Security First** - Built-in security headers and best practices

## šŸ“‹ Requirements

- **Node.js**: >= 18.x
- **npm**: >= 9.x
- **Vercel Account** (for deployment)

## šŸš€ Quick Start

### 1. Installation

```bash
# Clone the repository
git clone https://github.com/SourireConcept/cloudzir-mcp-server.git
cd cloudzir-mcp-server

# Install dependencies
npm install
```

### 2. Configuration

```bash
# Copy environment variables
cp .env.example .env

# Edit .env with your configuration
nano .env
```

### 3. Development

```bash
# Start development server
npm run dev
```

### 4. Production Build

```bash
# Build TypeScript
npm run build

# Start production server
npm start
```

## šŸ“‚ Project Structure

```
cloudzir-mcp-server/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ index.ts                 # MCP Server entry point
│   └── prompts/
│       ā”œā”€ā”€ system-prompts.ts    # CloudZIR system prompts
│       └── cloudzir-context.ts  # CloudZIR context & configuration
ā”œā”€ā”€ dist/                        # Compiled JavaScript output
ā”œā”€ā”€ package.json                 # Dependencies & scripts
ā”œā”€ā”€ tsconfig.json               # TypeScript configuration
ā”œā”€ā”€ vercel.json                 # Vercel deployment config
ā”œā”€ā”€ .env.example                # Environment variables template
└── README.md                   # This file
```

## šŸ” Environment Variables

Create a `.env` file based on `.env.example`:

```env
# Server Configuration
NODE_ENV=production
PORT=3000

# AI Model Configuration
OPENAI_API_KEY=sk-your-key-here
HUGGINGFACE_API_KEY=hf_your-token-here
ANTHROPIC_API_KEY=sk-ant-your-key-here

# Database
DATABASE_URL=postgresql://...

# Logging
LOG_LEVEL=info
DEBUG=false
```

## 🌐 Deployment on Vercel

### Option 1: Using Vercel Dashboard

1. Go to [Vercel Dashboard](https://vercel.com/dashboard)
2. Click "Add New" → "Project"
3. Select your GitHub repository
4. Vercel will auto-detect `vercel.json` configuration
5. Add environment variables in project settings
6. Deploy!

### Option 2: Using Vercel CLI

```bash
# Install Vercel CLI
npm i -g vercel

# Deploy
vercel

# Add environment variables
vercel env add OPENAI_API_KEY
vercel env add ANTHROPIC_API_KEY

# Deploy with environment variables
vercel --prod
```

## šŸ“” API Usage

### Initialize MCP Client

```typescript
import { Client } from "@modelcontextprotocol/sdk/client/index.js";

const client = new Client({
  name: "my-client",
  version: "1.0.0",
});

// Connect to CloudZIR MCP Server
await client.connect(transport);
```

### Access System Prompts

```typescript
import { SYSTEM_PROMPTS, getSystemPrompt } from "./src/prompts/system-prompts";

// Get master system prompt
const masterPrompt = getSystemPrompt("master");

// Get development context prompt
const devPrompt = getSystemPrompt("development");
```

## šŸ›ļø CloudZIR System Prompts

### Master Prompt
The core AI consciousness with CloudZIR's fundamental rules:
- Zero approximation
- Production-ready by default
- Complete, coherent, and connected logic
- Security and scalability built-in

### Development Prompt
Specialized context for platform development with:
- Code quality standards
- Component architecture guidelines
- Error handling requirements
- Performance optimization rules

### Infrastructure Prompt
Cloud infrastructure and deployment guidance:
- Security-first approach
- Scalability planning
- Monitoring and observability
- Disaster recovery procedures

## šŸ”§ Available Commands

```bash
# Development
npm run dev          # Start development server with hot reload
npm run build        # Compile TypeScript to JavaScript

# Production
npm start            # Run production server
npm run build && npm start

# Vercel
vercel               # Deploy to Vercel (staging)
vercel --prod        # Deploy to Vercel (production)
```

## šŸ“š Documentation

- [Model Context Protocol](https://modelcontextprotocol.io/)
- [Vercel Documentation](https://vercel.com/docs)
- [TypeScript Handbook](https://www.typescriptlang.org/docs/)
- [Node.js Documentation](https://nodejs.org/en/docs/)

## šŸ”’ Security

- āœ… All HTTP headers properly configured
- āœ… Input validation and sanitization
- āœ… Environment variables in `.env` (not committed)
- āœ… Secrets management through Vercel
- āœ… CORS configured for security
- āœ… SQL injection prevention
- āœ… XSS protection headers

## šŸ¤ Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request

## šŸ“ License

MIT License - see LICENSE file for details

## šŸ‘Øā€šŸ’» Author

**Sourire Concept**
- GitHub: [@SourireConcept](https://github.com/SourireConcept)
- Website: [sourire.concept](https://sourire.concept)

## šŸ™ Acknowledgments

- CloudZIR Platform Team
- Model Context Protocol Developers
- Vercel Platform
- TypeScript Community

---

**Made with ā¤ļø by Sourire Concept**