К основному содержанию
affpapa.org
RU EN
скилл Claude Code CX Codex Cursor GitHub Copilot

api-docs — скилл для Claude Code: что делает и как установить

Скилл собирает документацию по исходникам на TypeScript и JavaScript: находит публичные экспорты, разбирает JSDoc, дописывает недостающие комментарии и выдаёт OpenAPI 3.0 для HTTP-эндпоинтов.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓ 
npx skills add ruvnet/ruflo --skill api-docs -a claude-code
Открыть на GitHub

Что делает api-docs

Скилл проходит по каталогу с исходниками на TypeScript или JavaScript и собирает список публичного: функции, классы, интерфейсы. Дальше разбирает уже написанные комментарии JSDoc (@param, @returns, @throws, @example) и дописывает то, чего не хватает. Для HTTP-эндпоинтов отдельным шагом собирает описание в формате OpenAPI 3.0.

Работа идёт в четыре шага: сканирование экспортов, разбор JSDoc, генерация пропущенных описаний и сборка спецификации. Правила описания жёсткие. У каждого публичного экспорта должен быть комментарий, у @param и @returns — тип и описание, известные ошибки помечаются @throws, а неочевидные случаи получают @example. Если в проекте принят другой стиль комментариев, скилл будет переписывать файлы под этот.

Путь к исходникам передаётся аргументом. Диспетчеризация идёт через MCP-инструмент mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch с триггером document, а из Bash разрешён только npx *. Если MCP-сервер не подключён, шаг с диспетчеризацией не пройдёт — это первое, что стоит проверить при запуске.

Какие задачи решает

  • найти все публичные экспорты в незнакомом пакете
  • дописать JSDoc к функциям, где комментариев нет
  • собрать OpenAPI 3.0 по существующим HTTP-эндпоинтам
  • проверить, что у @param и @returns есть тип и описание
  • разметить исключения через @throws и примеры через @example

Примеры запросов агенту

  • Запусти api-docs на `src/api` и покажи, какие экспорты остались без JSDoc.
  • Пройди по `src/routes` и собери OpenAPI 3.0 для всех HTTP-эндпоинтов.
  • Добавь `@throws` в функции из `packages/core/src`, которые бросают ошибки.

Как установить api-docs

1Через Skills CLI (Vercel)

npx skills add ruvnet/ruflo --skill api-docs -a claude-code

2Вручную: положить файлы

~/.claude/skills/api-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/api-docs/

Из того же набора104

Весь набор →
ruflo ruvnet Скилл добавляет в проект оркестрацию мультиагентных задач, память, маршрутизацию и MCP-инструменты. Нужен для swarm-сценариев и многошаговых workflows. Claude Code CX Codex Cursor +1 4 000установок Swarm Orchestration ruvnet Скилл для управления роями агентов с параллельным выполнением задач, динамической топологией и автоматической балансировкой нагрузки. Нужен, когда одного агента недостаточно и требуется координировать специалистов разного профиля. Claude Code CX Codex Cursor +1 2 100установок github-project-management ruvnet Скилл превращает рутину вокруг issue и доски проекта в вызовы gh и ruv-swarm: метки, подзадачи, поиск дублей. Пригодится, когда задач много, а порядка в трекере нет. Claude Code CX Codex Cursor +1 1 400установок github-workflow-automation ruvnet Скилл автоматизирует GitHub Actions с координацией AI-агентов. Генерирует оптимальные pipeline, управляет pull request'ами, анализирует баги и развёртывает обновления с минимальными рисками. Claude Code CX Codex Cursor +1 1 300установок github-code-review ruvnet Организует параллельное код-ревью в GitHub с помощью агентов безопасности, архитектуры и стиля через пакет ruv-swarm. Claude Code CX Codex Cursor +1 1 300установок stream-chain ruvnet Организует последовательную передачу данных между шагами агента через цепочки промптов или готовые пайплайны. Claude Code CX Codex Cursor +1 1 200установок flow-nexus-swarm ruvnet Развёртывает облачные рои ИИ-агентов и собирает событийные процессы с очередями сообщений. Нужен для координации задач, контроля запусков и масштабирования роя. Claude Code CX Codex Cursor +1 1 200установок performance-analysis ruvnet Находит узкие места в Claude Flow swarms, профилирует операции агентов и генерирует отчёты с рекомендациями по оптимизации. Claude Code CX Codex Cursor +1 1 200установок

Похожие

pptx-slide-specification kimtth Скилл помогает писать и чинить JSON-описание слайдов с точными координатами, чтобы PPTX собирался предсказуемо и оставался редактируемым. Claude Code CX Codex Cursor 2 600установок dataset-curation Seth Hobson Скилл форматирует и проверяет датасеты для дообучения моделей. Пригодится перед запуском SFT или обучения на предпочтениях. Claude Code CX Codex Cursor 2 600установок write-pr tldraw Задаёт формат заголовков и описаний пулл-реквестов: семантические типы, структурированные шаблоны и правила изложения для ревьюера. Claude Code CX Codex Cursor +1 419установок prd-development deanpeters Помогает составить структурированный PRD из заметок дискавери, связав проблему, метрики и пользовательские истории. Пригодится перед запуском крупной фичи в разработку. Claude Code CX Codex Cursor +1 4 700установок pptx-quality-gates kimtth Проверяет и чинит редактируемые PPTX: геометрию, доступность, структуру OOXML и исходные ссылки. Нужен перед передачей готовой презентации. Claude Code CX Codex Cursor 2 500установок architect jsmastery-pro Скилл помогает выбрать стек, спроектировать фичу и зафиксировать технические решения. Он задаёт уточняющие вопросы и сохраняет готовые спецификации в docs/specs/. Claude Code CX Codex Cursor +1 6 800установок grill-with-docs Matt Pocock Скилл проводит жёсткое интервью по плану или дизайну и по ходу создаёт ADR и глоссарий. Подойдёт перед началом сложной разработки. Claude Code 1 219 756установок skill-creator официальный anthropics Помогает создать новый скилл, доработать существующий и проверить результат через тестовые промпты и оценки. Claude Code Claude.ai 414 180установок

Вопросы о api-docs

Как установить api-docs в Claude Code?

Выполните npx skills add ruvnet/ruflo --skill api-docs -a claude-code. Скилл окажется по пути ~/.claude/skills/api-docs/SKILL.md.

Что делает api-docs?

Сканирует экспорты в исходниках на TypeScript и JavaScript, разбирает существующие аннотации JSDoc, дописывает недостающие и генерирует OpenAPI 3.0 для HTTP-эндпоинтов.

Что нужно, чтобы скилл заработал?

Шаг диспетчеризации вызывает MCP-инструмент mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch с триггером document, поэтому этот MCP-сервер должен быть подключён. Сам скилл лежит в репозитории ruvnet/ruflo под лицензией MIT.

Исходный текст

SKILL.md · MIT 
---
name: api-docs
description: Generate API documentation from source code with JSDoc and OpenAPI support
argument-hint: "<source-path>"
allowed-tools: Bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch Read Write Grep
---
Generate API documentation from TypeScript/JavaScript source:

1. **Scan exports**: Find all public functions, classes, and interfaces
2. **Extract JSDoc**: Parse `@param`, `@returns`, `@throws`, `@example` annotations
3. **Generate missing docs**: Add JSDoc for undocumented public APIs
4. **OpenAPI spec**: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: `mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", context: "api" })`

Conventions:
- Every public export must have a JSDoc comment
- Include `@param` with type and description
- Include `@returns` with type and description
- Include `@throws` for known error conditions
- Include `@example` for non-obvious usage

© ruvnet · MIT · ruvnet/ruflo

Смотрите также

Спонсоры проекта

Компании, которые помогают держать аналитику открытой
Золотой спонсор AI-аналитика спроса на iGaming — индекс, тренды, конкуренты
Nutra.Club Закрытое сообщество Nutra-вертикали от команды M1

Показы, клики и копирования кода — открытая статистика. Мы держим цифры публичными по той же логике, что и сам NeBlask. Стать спонсором