Skip to main content
Glama
stufently

vkcloud-s3-mcp-ai-cli

README.md
# VK Cloud S3 MCP Server & AI CLI

![Status](https://img.shields.io/badge/status-development-blue) ![License](https://img.shields.io/badge/license-MIT-green)

MCP-сервер и CLI для S3 VK Cloud (ВК Облако): подключение Hotbox/Icebox к Claude Code, Cursor и Codex, просмотр объектов и скачивание бэкапов. Бинарь `vkcloud-s3` использует отдельный профиль возможностей облака.

[English guide](README.en.md) · [Каталог S3 MCP-серверов](https://stufently.github.io/s3-mcp-ai-cli-kit/)

## English

A Go MCP server, CLI and agent skill for VK Cloud S3 Object Storage. Connect Claude Code, Cursor and Codex to scoped object storage for inspection and backup recovery. ru-msk and kz-ast pools; bucket tagging is disabled. See the [full English guide](README.en.md).

## Быстрый старт

Возьми бинарь своей платформы из [Releases](https://github.com/stufently/vkcloud-s3-mcp-ai-cli/releases/latest) (v0.1.0 опубликован; есть в MCP Registry и Smithery) либо собери с Go 1.27.2:

```bash
bash scripts/go.sh go build -o vkcloud-s3 ./cmd/vkcloud-s3
./vkcloud-s3 version
./vkcloud-s3 auth set
./vkcloud-s3 auth status
./vkcloud-s3 ls --json
```

auth set спрашивает key ID и secret без эха; без TTY читает две строки stdin. Не передавай секрет в argv. Файл ~/.config/vkcloud-s3/credentials создаётся атомарно с 0600; более широкие права отклоняются.

Приоритет: флаги > env > файл. Переменные: VKCLOUD_S3_ACCESS_KEY_ID, VKCLOUD_S3_SECRET_ACCESS_KEY, VKCLOUD_S3_POOL (ru-msk), VKCLOUD_S3_ENDPOINT. HTTP требует VKCLOUD_S3_ALLOW_INSECURE=1.

Образ: ghcr.io/stufently/vkcloud-s3-mcp-ai-cli:0.1.0; локальная сборка: docker build -t vkcloud-s3 . Образ запускает MCP от uid 65532, содержит CA-сертификаты. Передай креды через приватное окружение/файл.

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

- Потоковые object CRUD, copy, multipart и presigned URL в пределах профиля.
- Версии, теги, CORS, политика и Object Lock configuration регистрируются при наличии поддержки.
- Ограниченные сканы, диагностика, JSON, установка MCP и встроенного skill.

## Подключение к Claude Code, Cursor, Codex

[![Add vkcloud-s3 MCP server to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=vkcloud-s3&config=eyJjb21tYW5kIjoiZG9ja2VyIiwiYXJncyI6WyJydW4iLCItaSIsIi0tcm0iLCItZSIsIlZLQ0xPVURfUzNfQUNDRVNTX0tFWV9JRCIsIi1lIiwiVktDTE9VRF9TM19TRUNSRVRfQUNDRVNTX0tFWSIsIi1lIiwiVktDTE9VRF9TM19QT09MIiwiZ2hjci5pby9zdHVmZW50bHkvdmtjbG91ZC1zMy1tY3AtYWktY2xpOjAuMS4wIl0sImVudiI6eyJWS0NMT1VEX1MzX0FDQ0VTU19LRVlfSUQiOiIke2VudjpWS0NMT1VEX1MzX0FDQ0VTU19LRVlfSUR9IiwiVktDTE9VRF9TM19TRUNSRVRfQUNDRVNTX0tFWSI6IiR7ZW52OlZLQ0xPVURfUzNfU0VDUkVUX0FDQ0VTU19LRVl9IiwiVktDTE9VRF9TM19QT09MIjoiJHtlbnY6VktDTE9VRF9TM19QT09MfSJ9fQ%3D%3D)

Кнопка ставит MCP из Docker-образа `ghcr.io/stufently/vkcloud-s3-mcp-ai-cli:0.1.0` в режиме только чтения. Ключи в конфиг не пишутся: Cursor подставляет `${env:…}` из окружения, поэтому задай `VKCLOUD_S3_ACCESS_KEY_ID` и `VKCLOUD_S3_SECRET_ACCESS_KEY` там, откуда запускается Cursor; `VKCLOUD_S3_POOL` — если бакет не в пуле по умолчанию (пустое значение = пул по умолчанию). Тот же блок — для Windsurf (`mcp_config.json`) и вручную для `~/.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "vkcloud-s3": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "VKCLOUD_S3_ACCESS_KEY_ID",
        "-e",
        "VKCLOUD_S3_SECRET_ACCESS_KEY",
        "-e",
        "VKCLOUD_S3_POOL",
        "ghcr.io/stufently/vkcloud-s3-mcp-ai-cli:0.1.0"
      ],
      "env": {
        "VKCLOUD_S3_ACCESS_KEY_ID": "${env:VKCLOUD_S3_ACCESS_KEY_ID}",
        "VKCLOUD_S3_SECRET_ACCESS_KEY": "${env:VKCLOUD_S3_SECRET_ACCESS_KEY}",
        "VKCLOUD_S3_POOL": "${env:VKCLOUD_S3_POOL}"
      }
    }
  }
}
```

```bash
vkcloud-s3 mcp install --client cursor --dry-run
vkcloud-s3 mcp install --client cursor
vkcloud-s3 mcp install --client claude-desktop
vkcloud-s3 mcp install --client codex
vkcloud-s3 mcp install --client claude-code --scope project
vkcloud-s3 mcp install --client claude-code --scope user
```

Последняя команда только печатает claude mcp add. Путь бинаря абсолютный; ключи в конфиг не пишутся. Cursor: ~/.cursor/mcp.json, Claude Code project: ./.mcp.json; Desktop — каталог конфигурации своей ОС. JSON сохраняет чужие ключи, .bak и идемпотентность.

Codex: ~/.codex/config.toml. Существующая таблица требует --force; заменяется только блок между # >>> vkcloud-s3 (managed) / # <<< vkcloud-s3 (managed). Таблица без маркеров не заменяется даже с --force; остальные байты TOML целы.

Уровни включаются независимо: vkcloud-s3 mcp --allow-write --allow-delete --allow-admin либо VKCLOUD_S3_ALLOW=write,delete,admin. Флаги доступны и в mcp install. FILE_ROOT включается через VKCLOUD_S3_FILE_ROOT.

## Инструменты MCP

| Level | Tools |
|---|---|
| read | s3_list_buckets, s3_list_objects, s3_head_object, s3_get_object, s3_preview_object, s3_presign_get, s3_list_object_versions, s3_list_multipart_uploads, s3_list_parts, s3_get_bucket_config, s3_largest_objects, s3_prefix_usage, s3_unfinished_uploads, s3_get_object_tagging |
| read + FILE_ROOT | s3_download_file |
| write | s3_put_object, s3_create_folder, s3_copy_object, s3_presign_put, s3_multipart_create, s3_multipart_presign_part, s3_multipart_complete, s3_put_object_tagging |
| write + FILE_ROOT | s3_upload_file |
| delete | s3_delete_object, s3_delete_objects, s3_multipart_abort |
| admin | s3_create_bucket, s3_put_bucket_versioning, s3_put_bucket_cors, s3_put_bucket_policy, s3_delete_bucket_policy, s3_put_object_lock_configuration |
| admin + delete | s3_delete_bucket |

Ресурсы: `vkcloud-s3://config`, `vkcloud-s3://capabilities`, `vkcloud-s3://pools`. Неподдерживаемые возможности исключают инструменты.

Списки — до 1000 элементов с continuation_token; версии/multipart имеют второй маркер. Inline get/put — 262144 байт, preview — 65536; большие файлы идут через presigned URL или FILE_ROOT. Ответ содержит structuredContent и JSON-текст; текст свыше 256 КиБ заменяется краткой сводкой. Ошибки: code/message/retryable; 429/503 SDK повторяет адаптивно.

Аналитика сканирует максимум max_scan (по умолчанию 10000); partial/token отмечают неполный результат. Prefix usage выдаёт страницы агрегатов через next_result_offset. Это не биллинг.

## Сценарий: Проверка Hotbox/Icebox и доступ к нужному региону

Профиль включает московский `ru-msk` и казахстанский `kz-ast` пулы. Выберите пул своего бакета, проверьте метаданные Hotbox/Icebox и создайте короткую ссылку для передачи существующего архива:

```bash
vkcloud-s3 --pool ru-msk stat backups/daily/archive.tar
vkcloud-s3 --pool ru-msk du backups/daily/ --max-scan 10000 --json
vkcloud-s3 --pool ru-msk presign backups/daily/archive.tar --expires 3600
```

Примеры используют существующий бакет `backups` и объект `daily/archive.tar`; замените их своими значениями. Профиль и API облака ещё требуют [живой проверки](TASKS.md).

## CLI

```bash
vkcloud-s3 mb backups
vkcloud-s3 cp ./archive.tar s3://backups/daily/archive.tar --part-size 5242880 --overwrite --yes
vkcloud-s3 ls backups/daily/ --max-keys 100 --json
vkcloud-s3 stat backups/daily/archive.tar
vkcloud-s3 cp s3://backups/daily/archive.tar ./restored.tar
vkcloud-s3 cp ./directory s3://backups/tree/ --recursive --overwrite --yes
vkcloud-s3 cp s3://backups/tree/ ./restored-directory --recursive
vkcloud-s3 cp s3://backups/daily/archive.tar s3://backups/copy.tar --overwrite --yes
vkcloud-s3 cat backups/daily/notes.txt
vkcloud-s3 versions backups/daily/ --json
vkcloud-s3 du backups/daily/ --max-scan 10000 --json
vkcloud-s3 presign backups/daily/archive.tar --expires 3600
vkcloud-s3 rm backups/copy.tar --yes
vkcloud-s3 rb empty-bucket --yes
vkcloud-s3 doctor --json
vkcloud-s3 compat --markdown
```

cp принимает обычные локальные пути и S3 URI s3://bucket/key либо vkcloud-s3://bucket/key. Большие загрузки используют manager/multipart, --recursive копирует каталоги/префиксы. Перезапись требует --overwrite и подтверждения; выгрузка атомарна. rm/rb/mv без --yes на не-TTY дают код 2; на TTY спрашивают. --json общий, ошибки — stderr и ненулевой код.

doctor проверяет источник/права кредов, DNS/TLS, часы по Date и ListBuckets: >5 минут — предупреждение, >15 — ошибка.

## Skill для AI-агентов

```bash
vkcloud-s3 skill install
vkcloud-s3 skill install --target ./agent-skills/vkcloud-s3
```

По умолчанию ~/.claude/skills/vkcloud-s3. Идемпотентно устанавливает SKILL.md и шесть references: backup/restore, share, least privilege, cost hygiene, migration, incident response. Триггеры: «vkcloud s3», «бакет VK Cloud», «загрузи в s3», «presigned», «бэкап в s3».

## Безопасность

Если `conditional_writes:false`, запись без перезаписи отказывает до S3-запросов: HEAD не даёт атомарной защиты. Для согласованной записи используй `--overwrite --yes` в CLI либо `overwrite:true, confirm:true` в MCP, сохраняя политику подтверждения. Если `conditional_delete:false`, `mv` и `s3_move_object` отключены.



MCP по умолчанию регистрирует только read; неподдерживаемые возможности и отсутствующие уровни исключают инструмент.

VKCLOUD_S3_DESTRUCTIVE_POLICY: confirm использует elicitation при поддержке клиента, иначе нужен confirm:true после согласия человека; elicit требует elicitation и не допускает обхода confirm:true; block всегда запрещает, allow выполняет без гейта. Отказ предшествует любым S3-запросам. Гейт покрывает удаления, move, presigned PUT, политику/Object Lock, suspension versioning и перезаписи.

При conditional_writes:true операции put/copy/move/multipart complete/upload file используют overwrite:false, HEAD цели и If-None-Match: *; при false запись по умолчанию отказывает. overwrite:true требует тот же гейт.

Скоуп: VKCLOUD_S3_ALLOWED_BUCKETS=backups и VKCLOUD_S3_ALLOWED_PREFIXES=backups/daily/. Префикс учитывает границу сегмента; daily-evil не подходит. Сегменты '..' отклоняются. Частичный скоуп запрещает целый бакет и широкие списки даже при наличии его в ALLOWED_BUCKETS. Copy/move проверяет источник и цель.

Файловые MCP-инструменты используют os.Root: только относительные пути внутри FILE_ROOT; '..', абсолютные пути и симлинки наружу отклоняются. На каждый вызов одна JSON-строка в stderr; VKCLOUD_S3_AUDIT_FILE дополнительно пишет в 0600. Секреты и X-Amz-Signature/Credential/Security-Token редактируются в логах/ошибках. Полная подписанная ссылка — только результат операции. Ограничивай также права самого S3-ключа.

s3_download_file по умолчанию публикует скачанный файл без замены существующего, в том числе созданного во время скачивания. Для замены передай overwrite:true: применяется разрушительная политика с подтверждением через форму либо confirm:true после согласия человека.

## Пулы и классы хранения VK Cloud

Пулы, эндпоинты и классы — в [таблице совместимости](docs/compat.md); каждый факт, цены и ошибки с первоисточниками — в [ресерче](docs/research/vkcloud-s3.md). Пул по умолчанию: `ru-msk`; регион SigV4 равен выбранному пулу. В профиле `verified:false`: проверка на versitygw не подтверждает API облака. Неподтверждённые сведения помечены **[предположение]**; цены в профиле не являются калькулятором биллинга.

Lifecycle, ACL, bucket tagging и object retention могут поддерживаться облаком, но эта версия не предоставляет инструментов для их настройки; данные профиля описывают совместимость S3 API.

## FAQ

**Как выбрать endpoint VK Cloud S3?** Используйте `VKCLOUD_S3_POOL=ru-msk` или `kz-ast`; соответствующий endpoint берётся из [профиля совместимости](docs/compat.md). Не меняйте регион подписи независимо от выбранного сервиса.

**Поддерживает ли этот проект Hotbox и Icebox?** Оба класса представлены в профиле как `STANDARD` и `STANDARD_IA`. Наличие класса в профиле не означает, что CLI автоматически переводит объекты между классами; особенности и цены указаны в [ресерче VK Cloud](docs/research/vkcloud-s3.md).

**Можно ли менять теги бакета VK Cloud через MCP?** `bucket_tagging` выключен; инструменты тегов объектов и бакета не следует считать взаимозаменяемыми. Проверяйте `vkcloud-s3://capabilities` и таблицу инструментов ниже.

**Что такое MCP-сервер?** Программа предоставляет агентам инструменты и ресурсы через Model Context Protocol; здесь stdio.

**Как подключить MCP-сервер к Claude Code?** Сохрани ключи auth set, затем используй project install либо напечатанную user-команду.

**Безопасно ли давать агенту доступ к S3?** Ограничь ключи, скоуп и уровни; сохрани confirm/block и одобряй разрушительные эффекты осознанно.

**Чем это отличается от aws-cli и rclone?** Бинарь объединяет MCP, гейт, аудит, аналитику, skill и CLI; aws-cli/rclone остаются самостоятельными средствами передачи/автоматизации.

**Какие возможности поддерживаются?** См. capabilities и [compat](docs/compat.md). Инструменты регистрируются по профилю; lifecycle, ACL, bucket tagging и object retention эта версия не настраивает.


## Другие провайдеры

[Общий каталог: MCP-серверы и CLI для российских S3](https://stufently.github.io/s3-mcp-ai-cli-kit/).

| Провайдер | Репозиторий | Сценарий |
|---|---|---|
| Selectel | [selectel-s3-mcp-ai-cli](https://github.com/stufently/selectel-s3-mcp-ai-cli) | Выбор пула и восстановление резервных копий |
| Yandex Cloud | [yandex-s3-mcp-ai-cli](https://github.com/stufently/yandex-s3-mcp-ai-cli) | Инвентаризация объектов и проверка версий бэкапов |
| VK Cloud | [vkcloud-s3-mcp-ai-cli](https://github.com/stufently/vkcloud-s3-mcp-ai-cli) | Проверка Hotbox/Icebox и доступ к нужному региону |
| Cloud.ru | [cloudru-s3-mcp-ai-cli](https://github.com/stufently/cloudru-s3-mcp-ai-cli) | Диагностика доступа к Evolution Object Storage |
| Timeweb Cloud | [timeweb-s3-mcp-ai-cli](https://github.com/stufently/timeweb-s3-mcp-ai-cli) | Восстановление архивов и учёт объёма префикса |
| MWS | [mws-s3-mcp-ai-cli](https://github.com/stufently/mws-s3-mcp-ai-cli) | Проверка HMAC-доступа и короткие ссылки на архивы |
| Beget | [beget-s3-mcp-ai-cli](https://github.com/stufently/beget-s3-mcp-ai-cli) | Просмотр и восстановление файлов из готового бакета |
| Shared Go kit | [s3-mcp-ai-cli-kit](https://github.com/stufently/s3-mcp-ai-cli-kit) | Общие MCP, CLI, защиты и CI |

## Лицензия

[MIT](LICENSE). [Проверенные факты и предположения](docs/research/vkcloud-s3.md).

Проверки в Docker: bash scripts/go.sh go test -race ./..., bash scripts/conformance.sh, bash scripts/mcp_smoke.sh, bash scripts/mutation_gate.sh, bash scripts/check_docs.sh. Conformance использует versitygw v1.8.0 и тестовые ключи.

Общие MCP/CLI, защиты и проверки поставляет [s3-mcp-ai-cli-kit v0.1.0](https://github.com/stufently/s3-mcp-ai-cli-kit/tree/v0.1.0); в этом репозитории остаются встроенный профиль, тонкий main и документы VK Cloud.

TDQS

C2.6/5.0

Scored across 14 tools

Disambiguation3/5

Most tools target distinct operations, but s3_unfinished_uploads and s3_list_multipart_uploads both surface unfinished multipart uploads, differing only in filtering/pagination, which invites misselection. The trio s3_get_object, s3_head_object, and s3_preview_object also overlap around reading object data, though their descriptions clarify the boundaries.

Naming Consistency4/5

All tools use a consistent s3_ prefix and lower snake_case, making the surface predictable. Most follow verb_noun (get_object, list_objects, head_object), but a few are noun phrases (largest_objects, prefix_usage, unfinished_uploads), a minor deviation from the dominant pattern.

Tool Count5/5

With 14 tools, the set is well within the sweet spot for an S3 inspection/diagnostics server. Each tool covers a distinct S3 capability (listing, metadata, config, tags, versions, multipart, analytics, presigning) without redundant filler.

Completeness3/5

The surface is entirely read/list/analysis oriented: there is no put_object, delete_object, copy, or abort_multipart_upload, so agents can detect problems (e.g. unfinished uploads, largest objects) but cannot remediate them. If read-only diagnostics is the intent this is reasonable, but it leaves notable lifecycle gaps for general S3 use.

Maintenance

ActivityMaintained
ResponsivenessNo issues