Agent integration
A deterministic workflow for agents deploying and configuring the gateway.
Agents should treat checked-in schemas and command output as authoritative. Do not infer production configuration from project-specific examples.
Safe workflow
- Inspect the target application's identity provider and runtime.
- Choose server API-key or issuer plus Apple App Attest authentication.
- Produce a candidate application JSON document.
- Validate it before applying it.
- Confirm Cloudflare authentication and required secrets without printing values.
- Perform a deployment dry run when available.
- Deploy, call
/v1/healthz, and confirm the application through the admin API. - Return the gateway URL, application ID, and non-secret client configuration.
Machine-readable sources
openapi/openapi.jsonis the generated HTTP contract.src/contracts/schemas.tscontains shared runtime schemas;src/contracts/openapi.tsassembles them into documented operations..dev.vars.examplelists required secret names without values.wrangler.jsoncdeclares Cloudflare resources and environments.
Secret rules
- Never place secrets in command arguments, source, documentation, or chat output.
- Use hidden prompts, stdin, ignored files, or a secret manager.
- Treat initial application API keys and development credentials as one-time outputs.
- Report where a credential was stored rather than repeating its value.