Oximy Docs

Public API

The public API and SDK documentation entrypoint.

Source artifacts

Public API artifacts currently live under the repo docs and package tree:

  • docs/developer/public-api.openapi.json
  • docs/developer/llms.txt
  • docs/developer/cli-commands.json
  • packages/public-api-client
  • packages/public-api-mcp

Generation

Use the repository scripts when public API contracts change:

pnpm generate:public-api
pnpm check:public-api-artifacts
pnpm check:public-api-cli
pnpm check:public-api-mcp

Docs shape

Public API docs should include:

  • Authentication and workspace scoping.
  • Endpoint groups and examples.
  • SDK and CLI usage.
  • Error handling and rate-limit behavior.
  • MCP server setup where applicable.

Local setup

Repo-oriented setup notes for engineers working on Oximy.

MCP gateway

Developer notes for Oximy's MCP gateway package and related policy controls.

On this page

Source artifactsGenerationDocs shape