mcp_db
README.md
# mcp_db — MCP-сервер метаданных корпоративных БД
MCP-сервер для Cursor: структура таблиц, неявные связи (из JOIN/WHERE в процедурах, функциях, триггерах и VIEW), зависимости объектов, экспорт в PlantUML.
## Статус
**v0.1.0** — каркас, metadata store, HTTP MCP-сервер, SQL-анализатор, extractors MS SQL / PostgreSQL, индексация `refresh`.
## Быстрый старт
```powershell
cd MCP_DB
python -m venv .venv311
.venv311\Scripts\activate
pip install -e ".[dev]"
copy config\config.example.yaml config\config.yaml
# задать GBD_USER, GBD_PASSWORD и т.д.
python -m mcp_db refresh --verbose
python -m mcp_db serve
```
Сервер: `http://0.0.0.0:8765/mcp` (Streamable HTTP). Health: `http://localhost:8765/health`.
## MCP Tools
| Tool | Описание |
|------|----------|
| `list_sources` | Источники и время индексации |
| `search_objects` | Поиск объектов |
| `describe_object` | Колонки и определение |
| `get_object_usages` | Входящие/исходящие зависимости |
| `get_table_relationships` | Граф связей, PlantUML / Mermaid |
| `get_dependencies_tree` | Дерево зависимостей |
| `refresh_metadata` | Запуск индексации |
| `execute_query` | Выполнение SQL (если `query_execution.enabled: true`) |
Права учётной записи БД: [docs/db-permissions.md](docs/db-permissions.md).
## Документация
| Документ | Содержание |
|----------|------------|
| [docs/TZ.md](docs/TZ.md) | Техническое задание |
| [docs/deployment.md](docs/deployment.md) | Развёртывание |
| [docs/db-permissions.md](docs/db-permissions.md) | Права пользователя БД (MS SQL, PostgreSQL) |
## Тесты
```bash
pytest
```
## Docker
```bash
docker compose -f docker/docker-compose.yml up -d
```
This server cannot be deployed
Maintenance
ActivityStale
ResponsivenessNo issues