Skip to content

Commit 422fa1f

Browse files
committed
docs(credits): make OpenAI-API-standards conformance explicit in section 22
Strengthens the 'AI agents used in this project' section to call out -- in a callout box at the top, and as a new column on the agent table -- that every listed agent (Claude/Code, Copilot, Cline, Cursor, Gemini CLI, Codex CLI / agents.md tools) is a *client* of the same OpenAI-shaped /v1 surface served by mios-ai.container at MIOS_AI_ENDPOINT, and that vendor-hardcoded URLs (api.openai.com, api.anthropic.com, generativelanguage.googleapis.com, etc.) are forbidden in the deployed image per Architectural Law 5: UNIFIED-AI-REDIRECTS. Adds a per-row 'OpenAI-API conformance' note describing how each agent's client is configured against the local /v1 endpoint (OPENAI_BASE_URL, 'OpenAI-compatible' provider settings, etc.) instead of native vendor APIs. Lists the OpenAI patterns shared across every agent: Chat Completions, Responses, function calling / tool-use schema, structured outputs (json_schema, strict), embeddings, MCP, model discovery, JSONL training format, Bearer auth.
1 parent edaca21 commit 422fa1f

1 file changed

Lines changed: 26 additions & 8 deletions

File tree

CREDITS.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -342,20 +342,38 @@ the source of truth for a given concern. When in doubt, these win:
342342

343343
## 22. AI agents used in this project
344344

345+
> **All agents in this project conform to OpenAI API standards and patterns.**
346+
> Architectural Law 5 (**UNIFIED-AI-REDIRECTS**): every agent listed below
347+
> resolves through `MIOS_AI_ENDPOINT=http://localhost:8080/v1`, an
348+
> OpenAI-public-API-compatible surface served by `etc/containers/systemd/mios-ai.container`
349+
> (LocalAI). Vendor-hardcoded URLs (`api.openai.com`, `api.anthropic.com`,
350+
> `generativelanguage.googleapis.com`, `api.cline.bot`, `api.cursor.com`,
351+
> `api.githubcopilot.com`, etc.) are forbidden in the deployed image and
352+
> fail audit. Each agent below is therefore a *client* of the same
353+
> OpenAI-shaped `/v1` surface; differences are presentation-layer only.
354+
>
355+
> **OpenAI patterns adopted across every agent:**
356+
> Chat Completions (`POST /v1/chat/completions`), Responses
357+
> (`POST /v1/responses`), function calling / tool-use schema, structured
358+
> outputs (`response_format: json_schema`, `strict: true`), embeddings
359+
> (`POST /v1/embeddings`), MCP tool invocation, model discovery
360+
> (`GET /v1/models`), JSONL training format, and `Authorization: Bearer ...`
361+
> auth. Each surface is anchored in section 7 above.
362+
345363
Coding/development AI agents that have first-class identity files in this
346364
repo. Each resolves the same canonical 'MiOS' system prompt at
347365
`/usr/share/mios/ai/system.md` (overridable via `/etc/mios/ai/system-prompt.md`
348366
and `~/.config/mios/system-prompt.md`); the agent-specific files below are
349367
thin pointers, not separate prompts.
350368

351-
| Agent | Vendor | Identity file in this repo | Vendor / docs |
352-
|---|---|---|---|
353-
| **Claude / Claude Code** | Anthropic | `CLAUDE.md`, `.claude/settings.local.json` | <https://www.anthropic.com/> -- <https://docs.claude.com/en/docs/claude-code/overview> |
354-
| **GitHub Copilot** | GitHub | `.github/ai-instructions.md` | <https://github.com/features/copilot> -- <https://docs.github.com/en/copilot> |
355-
| **Cline** (VS Code) | Cline | `.clinerules` | <https://cline.bot/> -- <https://github.com/cline/cline> |
356-
| **Cursor** (editor) | Cursor / Anysphere | `.cursorrules` | <https://cursor.com/> -- <https://docs.cursor.com/> |
357-
| **Google Gemini / Gemini CLI** | Google | `GEMINI.md` | <https://gemini.google.com/> -- <https://github.com/google-gemini/gemini-cli> |
358-
| **OpenAI Codex CLI** (and any agents.md-aware tool) | OpenAI / community | `AGENTS.md` (agents.md standard) | <https://github.com/openai/codex> -- <https://agents.md/> |
369+
| Agent | Vendor | Identity file in this repo | OpenAI-API conformance | Vendor / docs |
370+
|---|---|---|---|---|
371+
| **Claude / Claude Code** | Anthropic | `CLAUDE.md`, `.claude/settings.local.json` | Routed via `MIOS_AI_ENDPOINT` (OpenAI Chat Completions / Responses); native Anthropic Messages API not used in-image | <https://www.anthropic.com/> -- <https://docs.claude.com/en/docs/claude-code/overview> |
372+
| **GitHub Copilot** | GitHub | `.github/ai-instructions.md` | Repo-side instructions only; in-image AI use re-routed to `MIOS_AI_ENDPOINT` | <https://github.com/features/copilot> -- <https://docs.github.com/en/copilot> |
373+
| **Cline** (VS Code) | Cline | `.clinerules` | Configured to point its "OpenAI-Compatible" provider at `MIOS_AI_ENDPOINT` | <https://cline.bot/> -- <https://github.com/cline/cline> |
374+
| **Cursor** (editor) | Cursor / Anysphere | `.cursorrules` | "OpenAI-compatible" custom-model path set to `MIOS_AI_ENDPOINT` | <https://cursor.com/> -- <https://docs.cursor.com/> |
375+
| **Google Gemini / Gemini CLI** | Google | `GEMINI.md` | Uses Gemini CLI's OpenAI-compatibility flag against `MIOS_AI_ENDPOINT`; native `generativelanguage.googleapis.com` not used in-image | <https://gemini.google.com/> -- <https://github.com/google-gemini/gemini-cli> |
376+
| **OpenAI Codex CLI** (and any agents.md-aware tool) | OpenAI / community | `AGENTS.md` (agents.md standard) | Native OpenAI client; `OPENAI_BASE_URL` overridden to `MIOS_AI_ENDPOINT` for in-image use | <https://github.com/openai/codex> -- <https://agents.md/> |
359377

360378
Aliasing files that all point to the same canonical prompt:
361379

0 commit comments

Comments
 (0)