docs / Reference

Prompt files for AI assistants

Three Markdown files at stable URLs that give Claude, Copilot or any assistant the facts it needs to write correct ITOps registrations, push calls and API code.

Most of the YAML and JSON around ITOps is the kind of thing people now ask an assistant to write: a registration body for a service, a curl for a backup job, a GraphQL query for a dashboard. An assistant that guesses the field names produces plausible, wrong output. These files exist so it does not have to guess.

They are plain Markdown, served at fixed URLs, and kept in step with the product. Fetch them, paste them, or reference them from your assistant's configuration.

File Contents URL
01-overview.md what the platform is, the five-level path, the two ways data arrives, which endpoint does what https://www.mlops.hu/prompts/01-overview.md
05-rest-api.md every REST endpoint with its payload, status enums and warnings semantics https://www.mlops.hu/prompts/05-rest-api.md
10-gitops.md the full registration schema, field by field, with a worked Helm hook https://www.mlops.hu/prompts/10-gitops.md

Claude Code

Add the URLs to the project's CLAUDE.md so every session starts with them:

## ITOps
When writing ITOps registrations, push calls or API code, read these first:
- https://www.mlops.hu/prompts/01-overview.md
- https://www.mlops.hu/prompts/10-gitops.md
- https://www.mlops.hu/prompts/05-rest-api.md
Our node id is `acme/shop/prod/eu-1` and the API is `https://itops-api.corp.example.com`.

Or for a one-off:

Fetch https://www.mlops.hu/prompts/10-gitops.md, then write a Helm post-install
hook Job that registers our orders-api service under acme/shop/prod/eu-1 with
criticality high, SLA group checkout-flow and a daily backup expectation.

Other assistants

For an assistant without web access, download the three files into the repository (docs/itops/ is a reasonable place) and reference them the way its configuration allows: a system prompt, a .github/copilot-instructions.md, a Cursor rules file. Re-download them when you upgrade the platform.

mkdir -p docs/itops && cd docs/itops
curl -sO https://www.mlops.hu/prompts/01-overview.md
curl -sO https://www.mlops.hu/prompts/05-rest-api.md
curl -sO https://www.mlops.hu/prompts/10-gitops.md

What they will not do

They describe the API; they do not carry credentials, and the assistant will still need your API URL, node id and key from you. Tell it those in your own configuration, never in a prompt you paste somewhere public.

Versioning

The files carry the platform version they describe in their first line. They are rewritten with each release of these docs, and the URLs never change. The numbering leaves room for more files between them.

Documentation for ITOps 4.2 · charts itops 2.0.0, sla-portal 1.4.0 · rendered 2026-09-11