Passa al contenuto principale

Documentazione

Un backend, quattro vie d'accesso. Ogni sezione documenta gli stessi casi d'uso, quindi un concetto che impari nell'API REST è lo stesso concetto in MCP e nella CLI.

  • Iniziare

    Autenticazione, spazi di lavoro, progetti e il tuo primo post pubblicato.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

  • API REST

    Risorse, impaginazione, idempotenza, codici di errore e limiti di velocità.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

  • server MCP

    Trasporto, OAuth, catalogo degli strumenti, ambiti e handshake di approvazione.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

  • CLI

    Installa, autentica e il contratto di output leggibile dalla macchina.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

  • Webhook

    Catalogo eventi, verifica firma, tentativi e riconsegna.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

  • Requisiti per piattaforma, tipi di account, limiti e restrizioni note.

  • Riferimento all'errore

    Ogni codice di errore, cosa lo causa e cosa fare al riguardo.

    Non ancora pubblicatoQuesta sezione è scritta rispetto all'API fornita e viene pubblicata con essa. Preferiremmo mostrarti solo la documentazione per un endpoint che potrebbe cambiare.

Su cosa puoi contare

  • Ogni scrittura richiede una chiave di idempotenza. La riproduzione di una richiesta con la stessa chiave restituisce il risultato originale anziché creare un secondo post.
  • Ogni errore porta con sé un codice stabile, una chiave di messaggio e dettagli ripuliti. I codici non cambiano significato tra le versioni.
  • Le modifiche importanti ottengono una nuova versione e una finestra di deprecazione annunciata. I cambiamenti additivi no.
  • La lettura, la stesura, la richiesta di approvazione, la pianificazione e la pubblicazione sono ambiti separati. Una credenziale ottiene il set più piccolo che svolge il suo lavoro.

API and MCP Terms