For coding agents
This site is written to be read by agents as well as people.
| Resource | Where |
|---|---|
| An index of every page, for agents | /llms.txt |
| Every page in one file | /llms-full.txt |
| Any page as Markdown | The page's address with .md appended |
| The REST contract | /specs/openapi.yaml |
| The event contract | /specs/asyncapi.yaml |
| The gRPC contract | specs/proto/patternode/delve/v1/delve.proto in the repository |
| JSON Schemas | specs/schemas/ in the repository |
| Step-by-step instructions for an agent, and the repository's own map | AGENTS.md and llms.txt at the repository's root |
Rules for an agent building an integration
- The specs are the contract. Where a page and a spec disagree, the spec wins; report the difference.
- Build and test against the mock (
python mock/mock_patternode.py) before any real key is used. - Never write a key into code, a file, a commit, a log or a message. Read it from the environment or a secret store. Never ask a person to paste one into a chat.
- Never call a production endpoint with a live key unless the person you work for has asked you to, in this task.
- Copy the client from
examples/or generate one from the specs; keep the body hash, idempotency keys and retries, and store each forming series' edge with its segments (Your segment store). - Respect
x-status: do not build production paths onplannedoperations. - Start from the industry overlay that matches your user's data:
examples/industries/. - Getting real access is a person's step (Getting access): tell your user to email Patternode. Do not try to obtain keys yourself.