Spaces:
Configuration error
DEAF-FIRST MCP Server Setup - Quick Start Guide
What Has Been Created
This repository now contains a complete MCP (Model Context Protocol) server infrastructure for the DEAF-FIRST platform with 5 specialized services, a frontend, and a backend.
Repository Structure
DEAF-FIRST-PLATFORM/
βββ frontend/ # React + Vite frontend
βββ backend/ # Express backend API
βββ services/
β βββ deafauth/ # Authentication service + MCP server
β βββ pinksync/ # Real-time sync service + MCP server
β βββ fibonrose/ # Optimization engine + MCP server
β βββ accessibility-nodes/ # Accessibility features + MCP server
βββ ai/ # AI services + MCP server
βββ configs/deployment/ # Docker Compose configuration
βββ package.json # Root workspace configuration
βββ mcp-config.json # MCP servers configuration
βββ README.md # Main documentation
βββ MCP-SERVERS.md # MCP server documentation
βββ .env.example # Environment variables template
Quick Start
1. Install Dependencies
npm install
2. Set Up Environment
cp .env.example .env
# Edit .env with your configuration
3. Build All Services
npm run build
4. Run Development Environment
# Run all services
npm run dev
# Or run individual services
npm run dev:frontend
npm run dev:backend
npm run dev:deafauth
npm run dev:pinksync
npm run dev:fibonrose
npm run dev:a11y
MCP Server Usage
Running MCP Servers
Each service can be run as an MCP server:
# Build first
npm run build
# Run individual MCP servers
npm run mcp --workspace=services/deafauth
npm run mcp --workspace=services/pinksync
npm run mcp --workspace=services/fibonrose
npm run mcp --workspace=services/accessibility-nodes
npm run mcp --workspace=ai
Testing MCP Servers
Use the included test script:
node test-mcp.mjs services/deafauth/dist/mcp-server.js
node test-mcp.mjs services/pinksync/dist/mcp-server.js
node test-mcp.mjs services/fibonrose/dist/mcp-server.js
node test-mcp.mjs services/accessibility-nodes/dist/mcp-server.js
node test-mcp.mjs ai/dist/mcp-server.js
Claude Desktop Integration
Add to your Claude Desktop configuration:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"deafauth": {
"command": "node",
"args": ["/absolute/path/to/DEAF-FIRST-PLATFORM/services/deafauth/dist/mcp-server.js"]
},
"pinksync": {
"command": "node",
"args": ["/absolute/path/to/DEAF-FIRST-PLATFORM/services/pinksync/dist/mcp-server.js"]
},
"fibonrose": {
"command": "node",
"args": ["/absolute/path/to/DEAF-FIRST-PLATFORM/services/fibonrose/dist/mcp-server.js"]
},
"accessibility-nodes": {
"command": "node",
"args": ["/absolute/path/to/DEAF-FIRST-PLATFORM/services/accessibility-nodes/dist/mcp-server.js"]
},
"ai": {
"command": "node",
"args": ["/absolute/path/to/DEAF-FIRST-PLATFORM/ai/dist/mcp-server.js"]
}
}
}
Available Services
1. DeafAUTH (Port 3002)
Purpose: Accessible authentication and user management
MCP Tools:
authenticate_user: Login with username/passwordcreate_user: Create new user with accessibility preferencesget_user: Retrieve user profile
REST API:
POST /api/auth/login: User authenticationPOST /api/auth/register: User registrationGET /api/users/:userId: Get user info
2. PinkSync (Port 3003)
Purpose: Real-time data synchronization
MCP Tools:
sync_data: Synchronize data across channelssubscribe_channel: Subscribe to sync channelget_sync_status: Get sync status
REST API:
POST /api/sync: Sync dataGET /api/sync/status: Get sync status- WebSocket endpoint for real-time updates
3. FibonRose (Port 3004)
Purpose: Mathematical optimization engine
MCP Tools:
optimize_schedule: Optimize task schedulingcalculate_fibonacci: Calculate Fibonacci numbers (optimized O(n) algorithm)golden_ratio_analysis: Golden ratio calculations
REST API:
POST /api/optimize/schedule: Schedule optimizationGET /api/fibonacci/:n: Calculate FibonacciPOST /api/golden-ratio: Golden ratio analysis
4. Accessibility Nodes (Port 3005)
Purpose: Modular accessibility features
MCP Tools:
get_sign_language_interpretation: Sign language for text (ASL/BSL/ISL)apply_high_contrast: Apply high contrast modesimplify_text: Text simplificationget_accessibility_recommendations: Get WCAG recommendations
REST API:
POST /api/sign-language: Get sign language interpretationPOST /api/high-contrast: Apply high contrastPOST /api/simplify-text: Simplify textGET /api/recommendations/:contentType: Get recommendations
5. AI Services (Port 3006)
Purpose: AI-powered workflows
MCP Tools:
process_text: Summarize, translate, or simplify textgenerate_content: Generate accessible contentanalyze_accessibility: Analyze accessibility issues
REST API:
POST /api/process/text: Process text with AIPOST /api/generate: Generate contentPOST /api/analyze/accessibility: Analyze accessibility
6. Backend (Port 3000)
Purpose: Main backend API
REST API:
GET /health: Health checkGET /api/status: Service status
7. Frontend (Port 5173)
Purpose: React-based user interface
Features:
- Service overview dashboard
- Accessibility-first design
- Responsive layout
Docker Deployment
# Build Docker images
npm run build:docker
# Start all services
npm run docker:up
# View logs
npm run docker:logs
# Stop all services
npm run docker:down
Development Commands
# Development
npm run dev # Run all services
npm run dev:frontend # Frontend only
npm run dev:backend # Backend only
npm run dev:deafauth # DeafAUTH only
npm run dev:pinksync # PinkSync only
npm run dev:fibonrose # FibonRose only
npm run dev:a11y # Accessibility nodes only
# Building
npm run build # Build all workspaces
# Testing
npm run test # Run all tests
npm run test:e2e # End-to-end tests
# Code Quality
npm run lint # Lint code
npm run format # Format with Prettier
npm run type-check # TypeScript type checking
# Database
npm run db:setup # Setup databases
npm run db:migrate # Run migrations
npm run db:seed # Seed data
# Cleanup
npm run clean # Clean all artifacts
Environment Variables
Key environment variables (see .env.example for complete list):
# Databases
DATABASE_URL=postgresql://user:password@localhost:5432/deafirst
DEAFAUTH_DATABASE_URL=postgresql://user:password@localhost:5432/deafauth
# Redis
REDIS_URL=redis://localhost:6379
# JWT
JWT_SECRET=your-secret-key
JWT_EXPIRY=7d
# Service Ports
BACKEND_PORT=3000
DEAFAUTH_PORT=3002
PINKSYNC_PORT=3003
FIBONROSE_PORT=3004
A11Y_PORT=3005
AI_PORT=3006
# AI Services
OPENAI_API_KEY=your-api-key
Key Features
β Complete Monorepo: npm workspaces with all services β MCP Protocol: 5 MCP servers for programmatic access β TypeScript: Full type safety across all services β REST APIs: HTTP endpoints for all services β WebSocket: Real-time communication (PinkSync) β Docker Ready: Complete Docker Compose setup β Accessibility First: All services designed with accessibility in mind β Documentation: Comprehensive docs for all components β Testing: Test infrastructure included β Production Ready: Linting, type-checking, building all working
Architecture Highlights
- Deaf-First Design: All services prioritize accessibility
- MCP Integration: Programmatic access via Model Context Protocol
- Microservices: Independent, scalable services
- Type Safety: TypeScript with strict mode everywhere
- Input Validation: Zod schemas for all inputs
- Performance: Optimized algorithms (e.g., O(n) Fibonacci)
- Real-time: WebSocket support for live updates
- AI-Powered: Integration-ready for AI services
Next Steps
- Configure Environment: Update
.envwith your settings - Start Database: Run PostgreSQL and Redis (or use Docker)
- Install Dependencies: Run
npm install - Build Services: Run
npm run build - Start Development: Run
npm run dev - Test MCP Servers: Use test script or integrate with Claude
Documentation
README.md: Main project documentationMCP-SERVERS.md: Detailed MCP server documentationinfrastructure.md: Architecture overview.env.example: Environment configuration template
Support
For issues or questions:
- Review the documentation files
- Check service logs
- Open an issue on GitHub
License
MIT License - See LICENSE file
Built by 360 Magicians
DEAF-FIRST Platform v2.0.0