REST API
- OpenAPI document is the canonical machine-readable REST contract.
- API Catalog links the public REST and MCP service descriptions, documentation, and metadata.
- API lifecycle policy explains REST v1 compatibility, version negotiation, deprecation signals, typed errors, and rate limits.
Use the OpenAPI document for current paths and schemas. The lifecycle policy owns compatibility expectations; copied endpoint lists do not.
OAuth and protected-resource metadata
- OAuth protected-resource metadata describes the MakeFX MCP resource, authorization servers, scopes, and policy links.
- OAuth authorization-server metadata publishes authorization and token endpoints plus supported capabilities.
- OpenID Connect metadata provides the corresponding discovery document for compatible clients.
Clients should discover these documents at runtime instead of retaining endpoint or scope copies.
MCP
- Hosted MCP endpoint is the canonical Streamable HTTP resource and requires OAuth.
- MCP setup and agent guide explains connection, discovery, durable polling, recovery, and the shared product model.
- Official MCP Registry record publishes
app.makefx/make-effects; its same-origin manifest stays available for direct discovery.
After connecting, use tools/list and the public model tools for the current typed contract. MCP operates on the same Spaces, Assets, Variants, Recipes, References, Collections, and permissions as the web app.
MakeFX CLI
- CLI documentation covers installation, authentication, local files, JSON output, and command discovery.
- makefx on npm is the published package. Install it with
npm install -g makefx. - Machine-readable CLI contract provides stable discovery fields; live
makefx --helpowns commands and flags.
Use the CLI when work needs caller-local file upload or download. Use hosted MCP for structured remote operations.
Documentation and policies
- Documentation index lists every public guide; Markdown is the agent-readable twin.
- llms.txt is the concise agent index, and llms-full.txt provides bounded operational context.
- Privacy Policy explains information handling and the authoritative privacy contact.
- Terms of Service describes the rules for the website, app, CLI, MCP server, and related services.
Public HTML documents advertise their Markdown alternates. Live discovery contracts remain authoritative where commands, schemas, scopes, or service capabilities can change.