Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Document APIs, messages and webhooks v1.0.0

Use this resource to document a machine interface for the callers who depend on it

New

  • 403 downloads
  • 146 likes
  • 233 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install api-contract-documentation

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent describes each endpoint, field and error at the contract level, sorts details into four levels, separates an omitted field from a null one, and anchors types to their source. You get an API reference that a developer who cannot see the code can use.

Mostly picked by

Updated November 2, 2026

Card for the “Document APIs, messages and webhooks” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: four detail levels, DTO catalogue and reference template
  • SKILL.md: conventions, endpoints, messages and omitted versus null semantics

Good fit for

  • External developers keep asking what a field means
  • You must document the errors an endpoint returns

Not for

    Tags

    • api
    • documentation
    • contract
    • webhook
    • reference

    About

    You say

    “Document the orders API: endpoints, DTOs and error codes, from our controller.”

    Card for the “Document APIs, messages and webhooks” skill

    Skill published by riekelt under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to document a machine interface for the callers who depend on it
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md6.4 KB

    Origin and licence

    Listed unmodified

    Author
    riekelt
    Source
    github.com/riekelt/technical-writer/tree/85e53729dd959a2795d593d6769068e342cf3486/plugins/technical-writer/skills/documenting-contracts
    Licence
    MIT

    Notice

    « documenting-contracts » (riekelt, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.