# Prompts Index

Quick reference guide to all available prompts in diffray.

## Core Prompts

### `output-format.md` ⚙️
**Auto-included**: Yes (all agents)  
**Lines**: ~65  
**Purpose**: Defines JSON output format for all agents

**Key Sections**:
- JSON structure with required fields
- Field descriptions (file, lineStart, lineEnd, severity, category)
- Critical format requirements
- Examples

**Usage**: Automatically loaded via `loadOutputFormat()` in `executors/utils.ts`

---

### `validation.md` ✅
**Auto-included**: No (used by validation agent)  
**Lines**: ~177  
**Purpose**: Instructions for filtering false positives

**Key Sections**:
- Verification process (must use Read tool)
- Keep criteria (real, verified, proven issues)
- Filter criteria (false positives, noise, speculation)
- Intentional trade-offs recognition
- Examples of filtering patterns

**Usage**: Used by `validation` stage agent

---

## Specialized Domain Prompts

### `i18n.md` 🌍
**Auto-included**: No  
**Lines**: ~100  
**Purpose**: Internationalization review

**Focus Areas**:
- Hardcoded strings
- Missing translation keys
- Locale format issues (dates, numbers, currency)
- RTL (right-to-left) support
- String concatenation problems
- Translation file issues

**Agent**: `i18n.md` in `src/defaults/agents/`

---

### `database.md` 🗄️
**Auto-included**: No  
**Lines**: ~120  
**Purpose**: Database and ORM review

**Focus Areas**:
- N+1 query problems
- Missing indexes
- Migration safety
- Query performance
- Deadlock risks
- Data integrity
- ORM-specific issues

**Agent**: `database.md` in `src/defaults/agents/`

---

### `api-design.md` 🔌
**Auto-included**: No  
**Lines**: ~130  
**Purpose**: REST/GraphQL API design review

**Focus Areas**:
- HTTP method misuse
- Naming conventions
- Error response formats
- Pagination
- Versioning
- Request/response design
- Rate limiting & security
- GraphQL-specific issues

**Agent**: `api-design.md` in `src/defaults/agents/`

---

### `observability.md` 📊
**Auto-included**: No  
**Lines**: ~140  
**Purpose**: Logging, monitoring, and error tracking review

**Focus Areas**:
- Missing logging
- Unstructured logging
- Missing context (request_id, trace_id)
- Error tracking
- Metrics & monitoring
- Security & privacy in logs
- Distributed tracing

**Agent**: `observability.md` in `src/defaults/agents/`

---

### `data-privacy.md` 🔒
**Auto-included**: No  
**Lines**: ~150  
**Purpose**: GDPR/PII handling and compliance review

**Focus Areas**:
- PII exposure
- Missing consent checks
- Data retention
- Encryption & storage
- Data access & portability
- Third-party data sharing
- Data minimization

**Agent**: `data-privacy.md` in `src/defaults/agents/`

---

## Quick Stats

| Prompt | Lines | Status | Agent |
|--------|-------|--------|-------|
| `output-format.md` | ~65 | Auto-included | All |
| `validation.md` | ~177 | Manual | validation |
| `i18n.md` | ~100 | Manual | i18n |
| `database.md` | ~120 | Manual | database |
| `api-design.md` | ~130 | Manual | api-design |
| `observability.md` | ~140 | Manual | observability |
| `data-privacy.md` | ~150 | Manual | data-privacy |

**Total**: 7 prompts, ~880 lines

## Usage Patterns

### Pattern 1: Auto-included (output-format.md)
```typescript
// Automatically added to all agents
const format = await loadOutputFormat();
const fullPrompt = buildPrompt(systemPrompt, input, format);
```

### Pattern 2: Agent-specific (validation.md)
```markdown
---
name: validation
stage: validation
---

[Content from validation.md prompt]
```

### Pattern 3: Reference in agent (specialized prompts)
```markdown
---
name: my-agent
---

You are a database reviewer.

See ../prompts/database.md for detailed guidelines.
```

## Related Documentation

- **README.md**: Full documentation on prompts
- **AGENTS.md**: Agent configuration guide
- **ARCHITECTURE.md**: System architecture overview