# database-documentation

Скилл исследует живую базу данных и сверяет её с ORM, миграциями и типами. Помогает составить точный data dictionary, диаграмму связей в Mermaid и файл schema.json.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 522 установки · ★ 17
- Автор: a-tokyo
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/a-tokyo/agent-skills/tree/HEAD/skills/database-documentation/SKILL.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/skills/database-documentation

## Что делает

Скилл строит документацию к реляционной базе данных по принципу двойной проверки. За основу он берёт системный каталог работающей СУБД, а затем сверяет полученную схему с моделями ORM, миграциями и кодом запросов приложения. Процесс исключает догадки нейросети: агент формирует файл `schema.json`, строит Mermaid-диаграммы сущностей и генерирует таблицы с описанием полей.

Работа идёт по фазам через временную директорию `.database-documentation/`. Сначала инструмент определяет движок и ищет способ подключения: через MCP-сервер, `docker compose exec` или локальный CLI (`psql`, `mysql`, `sqlite3`, `sqlcmd`). Пароли из `.env` маскируются и в итоговые документы не попадают. Затем параллельные субагенты считывают таблицы, внешние ключи, триггеры, последовательности и представления, сохраняя тела процедур целиком.

Инструмент рассчитан только на реляционные базы: PostgreSQL, MySQL, SQL Server и SQLite. Если в проекте обнаружен документный стор вроде MongoDB, скилл остановит работу на этом источнике. Без доступа к реальной базе скилл переходит в режим деградации и не сможет доказать отсутствие расхождений.

## Требования
- Работает с: PostgreSQL

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add a-tokyo/agent-skills --skill database-documentation -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/database-documentation/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/database-documentation/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add a-tokyo/agent-skills --skill database-documentation -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/database-documentation/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add a-tokyo/agent-skills --skill database-documentation -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/database-documentation/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install a-tokyo/agent-skills database-documentation
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/database-documentation/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add a-tokyo/agent-skills --skill database-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/a-tokyo/agent-skills --path skills/database-documentation
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/database-documentation/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add a-tokyo/agent-skills --skill database-documentation -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/a-tokyo/agent-skills/tree/HEAD/skills/database-documentation/SKILL.md

## Когда брать
- составить документацию по схеме живой реляционной базы данных
- построить ER-диаграмму связей таблиц в формате Mermaid
- проверить расхождения между моделями ORM и реальным каталогом СУБД
- выгрузить машиночитаемую спецификацию в файл schema.json

## Примеры запросов агенту
- Сделай документацию к базе данных проекта и проверь расхождения со схемой Prisma.
- Построй ER-диаграмму в Mermaid и подготовь словарь данных по нашей PostgreSQL.
- Просканируй живую базу данных через docker compose и сформируй schema.json.

## Похожие
- [xlsx](https://affpapa.org/nevibecode/skills/xlsx.md) — скилл · 187223 установки
- [google-agents-cli-observability](https://affpapa.org/nevibecode/skills/google-agents-cli-observability.md) — скилл · 511300 установок
- [caveman-evidence-review](https://affpapa.org/nevibecode/skills/caveman-evidence-review.md) — скилл · 104500 установок
- [migration](https://affpapa.org/nevibecode/skills/migration.md) — скилл · 103900 установок
- [performance-optimization](https://affpapa.org/nevibecode/skills/performance-optimization.md) — скилл · 65200 установок
- [supabase](https://affpapa.org/nevibecode/skills/supabase.md) — скилл · 8 установок

Из того же набора: [a-tokyo/agent-skills](https://affpapa.org/nevibecode/by/a-tokyo/agent-skills.md) — 3 карточки

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md