Docs

leaseclock.com/docs has a page for every Noun and Verb, with examples that run against Test. Every page is also served as Markdown, so your customers' agents read the same docs your customers do.

In shortCopy link to this section

curl -X POST https://leaseclock.com/api/leases/4b/renew \  -H "Authorization: Bearer $LEASECLOCK_TOKEN" \  -d '{ "endsOn": "2027-11-30" }'

Your customers get a docs site at /docs on your domain, in your theme, and you write none of it. Each Noun has a page with its fields and the calls that list, read, create and update it. Each Verb has a section on its Noun's page, with its input and the same call in curl, TypeScript, the CLI and MCP. A field you add is documented the moment it exists.

Open leaseclock.com/docs

Leaseclock's docsCopy link to this section

Leaseclock's docs open on Quickstart and API keys, then give Lease and Unit a page each. Priya Shah, the leasing coordinator at Northgate Rentals, opens leaseclock.com/docs/lease#renew when she scripts the month's renewals. Every heading, row and example on that page comes from one file:

---
$type: Noun
$id: leaseclock.com/nouns/Lease
name: Lease
fields:
  unit: { type: link, target: Unit, required: true }
  renter: { type: email, required: true }
  endsOn: { type: date, required: true, indexed: true }
  status: { type: choice, options: [{ key: active }, { key: ended }] }
verbs:
  renew:
    does: Move the end date forward
    input: { endsOn: { says: the new end date, type: date, required: true } }
    from: [active]
    fn: { kind: code, body: replace }
  end: { does: End the lease, from: [active], to: ended }
---

Each line decides something a reader sees:

Examples that run against TestCopy link to this section

Every example comes in four forms: curl, TypeScript, the CLI and MCP. A signed-in reader's examples point at their own Test workspace, and Run sends the call there and shows the response in place. Test is a full copy of Leaseclock where no real charge happens, so Priya can renew 4B from the docs without touching Northgate's live leases.

These are the four forms of the renew example on leaseclock.com/docs/lease#renew:

curl -X POST https://leaseclock.com/api/leases/4b/renew \
  -H "Authorization: Bearer $LEASECLOCK_TOKEN" \
  -d '{ "endsOn": "2027-11-30" }'

Run shows what the API returns: the Lease as it now stands, and the link that undoes the renewal.

{
  "$id": "https://leaseclock.com/api/leases/4b",
  "$type": "Lease",
  "unit": "4b",
  "renter": "dana.whitfield@example.com",
  "endsOn": "2027-11-30",
  "status": "active",
  "renewedBy": "priya@northgaterentals.com",
  "undo": "https://leaseclock.com/api/leases/4b/undo"
}

Each push of your definition runs every example against Test before the new version is served. A call printed in your docs is a call your API accepts.

Markdown for agentsCopy link to this section

Every docs page has a Markdown copy at the same path with .md added. A request for the page with Accept: text/markdown gets the same Markdown, and each page has a Copy Markdown button for pasting into Claude, ChatGPT or Cursor.

curl https://leaseclock.com/docs/lease.md

## Renew a Lease

Moves the end date forward. Runs on an active Lease, and keeps its status.

| Input | Type | Description |
| --- | --- | --- |
| `endsOn` (required) | date | The new end date |

```bash
curl -X POST https://leaseclock.com/api/leases/4b/renew \
  -H "Authorization: Bearer $LEASECLOCK_TOKEN" \
  -d '{ "endsOn": "2027-11-30" }'
```

Returns the Lease. Undo it with `POST /api/leases/4b/undo`.

leaseclock.com/llms.txt lists every docs page with a one-line summary, so an agent finds the Lease page without crawling the site. The Site page covers llms.txt and the OpenAPI file.

Your own pagesCopy link to this section

Write a guide, such as one on renewing a building's leases in one pass, as an MDX file in Docs/ and push it with the definition. Docs/bulk-renewals.mdx is served at leaseclock.com/docs/bulk-renewals, in the sidebar beside the generated pages, in your theme, with its own Markdown copy and its own line in llms.txt.

Text under a Noun's frontmatter opens that Noun's page:

---
$type: Noun
$id: leaseclock.com/nouns/Lease
name: Lease
# fields and verbs as before
---

A Lease ties a renter to a Unit until a date. Renew it before `endsOn` and the renter keeps the unit.

To replace a generated page with your own React component, see Defaults and overrides.

FAQCopy link to this section

When does a change reach the docs? On the next request after you push it. When Lease gained a rent field, leaseclock.com/docs/lease gained a rent field typed money, the create example gained a rent value, and the changelog entry "Leases now track rent" linked to the page. The Blog page covers the changelog.

Do the docs carry my brand? Yes. They are served at leaseclock.com/docs in Leaseclock's teal theme, under Leaseclock's name. Nothing on them names SaaS.Dev.

Who can read them? Anyone, without signing in. Run needs a signed-in reader, and sends calls only to that reader's own Test workspace. Each reader sees the Verbs their role may run, so a Verb kept to your team appears only in your team's docs.

Which languages do the examples use? curl, TypeScript with the leaseclock package, the npx leaseclock CLI, and MCP tool calls. The SDK, CLI and MCP pages cover each one.

Can a customer's agent read the docs and act on them? Yes. The agent reads leaseclock.com/docs/lease.md to learn renew's input, then calls do on leaseclock.com/mcp with that same input, under the customer's own permissions.