Метрики репозиторію

Інтерфейси для ШІ

Як inspect.software вимірює машиночитані інтерфейси — схеми API, сервери MCP та придатні до запуску приклади. Частина бейджа «Готовність до ШІ».

Методологія v1.13.0Оновлено 2026-07-13

Інтерфейси для ШІ вимірюють, чи надає проєкт машиночитані інтерфейси: формальні схеми API, сервер Model Context Protocol або придатні до запуску приклади. Там, де вони існують, ШІ-агент може споживати програмне забезпечення через контракт, а не відновлювати поведінку зворотним аналізом вихідного коду.

  • Категорія: Готовність до ШІ (15% у межах категорії)
  • Вага в загальному індексі: 0% — частина незалежного бейджа «Готовність до ШІ»
  • Ключ метрики: ai_interfaces
  • null, коли репозиторій не має жодного із сигналів — відсутність трактується як незастосовність, а не як штраф

Як обчислюється значення

КомпонентВагаПідтвердження
Схема API40файли OpenAPI/Swagger, GraphQL SDL, protobuf або AsyncAPI
Сервер MCP20залежність сервера Model Context Protocol або конфігурація mcp.json
Придатні до запуску приклади40каталоги examples/, recipes/ чи samples/ або блокноти

Правило null — пояснення

Проста бібліотека-утиліта цілком закономірно не має ні схеми API, ні поверхні MCP, а можливо, й каталогу прикладів — і було б неправильно знижувати їй оцінку за її природу. Тому метрика дає значення лише тоді, коли наявний хоча б один сигнал; інакше вона дорівнює null, і категорія Готовність до ШІ перенормовується на решту своїх метрик за загальнометодологічним правилом щодо відсутніх даних (див. індекс здоров'я).

Чому саме ці три сигнали

  • Схеми API — це контракти, які модель може прочитати точно: кінцеві точки, типи й помилки без здогадок.
  • Сервер MCP — найсильніша з можливих заява про готовність до агентів: проєкт постачає повноцінний інтерфейс для інструментів ШІ.
  • Придатні до запуску приклади — це виконувана документація. Для агента робочий приклад є перевіреною відправною точкою, а не прозою для тлумачення — до того ж приклади слугують фактичним тестом публічного API.

Як покращити значення

  • Опублікувати схему API, яку проєкт уже неявно має: згенерувати OpenAPI з фреймворку, закомітити файли .proto або GraphQL SDL.
  • Вести каталог examples/ із невеликими придатними до запуску програмами, актуальність яких підтримується в CI.
  • Там, де проєкт природно обслуговує інструментарій, розглянути постачання сервера MCP.

Дивіться також: контекст для ШІ-агентів · Готовність до ШІ