AI Assistant Instructions - Overview

This document provides an overview of where AI assistants can find instructions for working with DiveSuite.

Instruction Files by AI Assistant

GitHub Copilot

File: .github/copilot-instructions.md Format: Markdown Loaded: Automatically by GitHub Copilot in VS Code Contains: Project context, safety rules, coding standards, tool preferences, design system

Claude (via Cursor, VS Code Extension, or API)

File: CLAUDE.md Format: Markdown Loaded: Referenced in prompts or via custom instructions Contains: Full project instructions, architecture rules, detailed design system guide

ChatGPT / OpenAI API

File: .openai/instructions.md Format: Markdown Loaded: Copy into ChatGPT Custom Instructions or API system prompt Contains: Condensed project overview, safety rules, coding standards

Cursor IDE Rules

Directory: .cursor/rules/ Format: .mdc (Markdown Cursor) Loaded: Automatically by Cursor IDE Files:

• typescript.mdc - TypeScript coding standards
• rust.mdc - Rust coding standards
• markdown.mdc - Documentation standards
• ui-components.mdc - UI/Design system guide with MCP usage

Agent-Specific Roles

File: AGENTS.md Purpose: Defines specialized agent roles for different development tasks Agents:

• Deco Engine Developer (Rust/safety-critical)
• Feature Developer (TypeScript/React Native)
• Database Developer (WatermelonDB)
• AI Integration Developer
• Test Engineer
• Documentation

MCP Server Integration

What: Model Context Protocol server for Gluestack UI component documentation Location: ~/Documents/MCP/gluestack-mcp/ Configuration: ~/Library/Application Support/Code/User/settings.json

Mentioned in:

• .github/copilot-instructions.md (Design System & MCP section)
• CLAUDE.md (Design System & Component Library section)
• .openai/instructions.md (Design System section)
• .cursor/rules/ui-components.mdc (Full MCP usage guide)
• MCP Setup (Setup documentation)

Provides:

• get_all_components_metadata - List available components
• select_components - Select components to work with
• get_selected_components_docs - Get full documentation

Design System Documentation

Primary References:

1. .cursor/rules/ui-components.mdc - Complete UI guide (query MCP first!)
2. components/ui/gluestack-ui-provider/config.ts - Theme configuration
3. MCP Setup - MCP server setup

Key Rules:

• Import from @/components/ui/ only
• Use className with Tailwind, NO StyleSheet
• Query MCP server before generating UI code
• No HTML tags in React Native
• Prefer VStack/HStack over Box
• Images only from unsplash.com

Safety-Critical Code

All instruction files emphasize:

1. NEVER modify rust-engine/ without explicit request
2. NEVER bypass decompression validation
3. NEVER remove safety disclaimers
4. NEVER hide safety warnings (ppO2, MOD, NDL, gas reserve)

Maintenance

When updating instructions:

1. Update CLAUDE.md first (most comprehensive)
2. Sync relevant sections to .github/copilot-instructions.md
3. Condense for .openai/instructions.md
4. Update .cursor/rules/*.mdc for specific rule changes
5. Document in CHANGELOG.md

Quick Reference

AI Assistant	Main File	Focus
GitHub Copilot	.github/copilot-instructions.md	Quick reference
Claude Code	CLAUDE.md	Complete guide
Cursor IDE	.cursor/rules/ui-components.mdc	UI/Design system
ChatGPT	.openai/instructions.md	General guidance
Any Agent	AGENTS.md	Role-based rules

Testing Instructions

To verify instructions are working:

1. Ask AI: “What design system does DiveSuite use?”
   • Expected: Gluestack UI v3 + NativeWind
2. Ask AI: “How do I import a Button component?”
   • Expected: import { Button } from '@/components/ui/button'
3. Ask AI: “What Gluestack components are available?”
   • Expected: AI uses MCP tool to query available components