Перейти до основного вмісту

Документація

Один бекенд, чотири входи. Кожен розділ документує однакові випадки використання, тому концепція, яку ви вивчаєте в REST API, є тією самою концепцією в MCP і в CLI.

  • Початок роботи

    Автентифікація, робочі області, проекти та ваша перша публікація.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

  • REST API

    Ресурси, розбивка на сторінки, ідемпотентність, коди помилок і обмеження швидкості.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

  • Сервер MCP

    Транспорт, OAuth, каталог інструментів, обсяги та рукостискання затвердження.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

  • CLI

    Інсталяція, автентифікація та машинозчитуваний вихідний контракт.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

  • Веб-хуки

    Каталог подій, перевірка підпису, повторні спроби та повторна доставка.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

  • Вимоги до платформи, типи облікових записів, обмеження та відомі обмеження.

  • Посилання на помилку

    Кожен код помилки, що її викликає та що з нею робити.

    Ще не опублікованоЦей розділ написаний проти надісланого API і публікується разом з ним. Ми не покажемо вам нічого, ніж документацію для кінцевої точки, яка може змінитися.

Те, на що можна покластися

  • Кожен запис приймає ключ ідемпотентності. Повторне відтворення запиту з тим самим ключем повертає вихідний результат, а не створює другу публікацію.
  • Кожна помилка містить стабільний код, ключ повідомлення та деталізовані деталі. Коди не змінюють значення між версіями.
  • Критичні зміни отримують нову версію та оголошений період припинення підтримки. Адитивні зміни не роблять.
  • Читання, складання, запит на затвердження, планування та публікація є окремими сферами. Облікові дані отримують найменший набір, який виконує свою роботу.

API and MCP Terms