# Документация Crank

Crank превращает REST API endpoint-ы в MCP-инструменты, которые можно подключать к AI-агентам и MCP-клиентам.

Документация хранится в Markdown-файлах внутри `docs/` и читается прямо из репозитория.

## Начать

- [Введение](./intro.md)
- [Установка](./installation.md)
- [Первый инструмент](./quickstart.md)
- [Подключение MCP-клиента](./mcp-interface.md)
- [Практические API-примеры](./api-examples.md)

## Возможности

- [Веб-интерфейс](./ui.md)
- [REST-инструменты](./protocols/rest.md)
- [Импорт OpenAPI](./openapi-import.md)
- [Секреты и профили авторизации](./secrets-and-auth.md)
- [Журналы и использование](./observability.md)
- [Единая граница REST execution](./execution-boundary.md)
- [Проектирование MCP-инструментов](./tool-design.md)

## Справочник

- [Capability Inventory](./capability-inventory.json) — machine-readable реестр
  текущих и целевых flows; canonical path — `docs/capability-inventory.json`.
- [Schema Capability Inventory](./schemas/capability-inventory.schema.json)
- [Capability Baseline](./capability-baseline/manifest.json) — versioned SHA-256
  snapshot фактических UI, Admin API и MCP flows, taxonomy, checklist и
  sanitized evidence results.
- [Schema Capability Baseline](./schemas/capability-baseline.schema.json) —
  fail-closed manifest contract.
- [Настройки окружения](./runtime-config.md)
- [Machine schema runtime-конфигурации](./schemas/runtime-config.schema.json)
- [Миграции PostgreSQL](./migrations.md)
- [Machine sequence миграций](./schemas/migration-sequence.json)
- [Admin API](./admin-api.md)
- [Развертывание](./deployment.md)
- [Production checklist](./production-checklist.md)
- [Troubleshooting](./troubleshooting.md)
- [Архитектура](./architecture.md)
- [Модель данных](./data-model.md)
- [Тестирование](./testing-strategy.md)

В Inventory только статус `implemented` означает готовность. Статусы `planned`,
`gap` и `blocked` остаются непроходными и не являются заявлением о наличии
функции в текущей Community-версии.

Baseline разделяет implementation status, execution verdict и evidence mode.
Полный pass — только `implemented + automated + pass`; `flaky`, `skipped`,
`not_run` и `manual_only` остаются non-pass. После изменения snapshot должны
обновиться `baseline_version` и manifest checksums.