Skip to content

docs: add Codex and Claude Harness examples and a codex runtime-image conref - #566

Merged
Rachael-Graham merged 4 commits into
kagent-dev:mainfrom
chinmaychahar:docs/harness-codex-claude-examples
Oct 12, 2026
Merged

Rachael-Graham merged 4 commits into
kagent-dev:mainfrom
chinmaychahar:docs/harness-codex-claude-examples

Conversation

@chinmaychahar

@chinmaychahar chinmaychahar commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Closes #530

Adds Codex and Claude Harness examples to agents/agent-harness.md and a runtime-image-codex conref that the ref-docs job resolves

Placement: both examples go on the harness page, next to the existing example and the runtime tables, so a reader can compare the runtimes in one place. Open to suggestions.

Done when

  • Codex Harness example with its ModelConfig and an AgentTemplate, run on a cluster
  • Claude Harness example on the same terms
  • runtime-image-codex.md exists and resolves; the other two conrefs still resolve
  • runtime-image-claude.md is referenced by a page again
  • Every image is digest-pinned
  • Placement question answered

Testing

On kind with kagent 1.0.0-alpha9, both Agents reach Ready with no warnings and Sessions start on both. A Codex ModelConfig without apiFormat: responses is rejected

UI


01-agents

@chinmaychahar
chinmaychahar marked this pull request as ready for review October 8, 2026 15:37

@Rachael-Graham Rachael-Graham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran both examples on a kind cluster running kagent 1.0.0-alpha8 with Agent Substrate 0.4.0-alpha1, applied exactly as the page renders them.

Codex. All three resources are accepted, the Agent reports Accepted, ResolvedRefs, Compatible and Ready with no warnings, the Session reaches RUNTIME_STATE_READY, and a turn returns the model's reply. The manifest is correct as written.

Claude. Same four conditions, no warnings, and the Session starts and reaches the Anthropic API. I have no Anthropic key, so the turn itself ends at Invalid API key · Fix external API key — everything up to the model call is verified, the model call is not.

Also checked: both manifests pass the alpha8 CRD schemas with no unknown or missing fields and every CEL rule satisfied, the digest you pinned is the one GHCR serves for codex-harness:1.0.0-alpha8, the Secret names and keys match the OpenAI and Anthropic guides, both provider links and the #model-provider-support anchor resolve in a local build, and the page builds clean with both tabs rendering.

The deploy check fails because a pull request from a fork cannot read CLOUDFLARE_API_TOKEN. Nothing for you to fix.

Comments inline.

Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md Outdated
Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md Outdated
Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md Outdated
Comment thread .github/workflows/update-ref-docs.yaml
Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md
Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md Outdated
Comment thread docs-site/content/kagent/1.x/agents/agent-harness.md Outdated
Signed-off-by: chinmaychahar <chinmay.cc.06@gmail.com>
Signed-off-by: chinmaychahar <chinmay.cc.06@gmail.com>
Signed-off-by: chinmaychahar <chinmay.cc.06@gmail.com>
Signed-off-by: chinmaychahar <chinmay.cc.06@gmail.com>
@chinmaychahar
chinmaychahar force-pushed the docs/harness-codex-claude-examples branch from 4c77236 to ea3bea6 Compare October 12, 2026 09:46
@chinmaychahar

chinmaychahar commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor Author

@Rachael-Graham thanks for the review! I've addressed them and also rebased onto mainline/alpha9

I re-ran both examples fresh. Updated screenshots
02-harnesses

02-templates 01-agents

@Rachael-Graham Rachael-Graham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Running the workflows and once those pass I will merge. Thank you very much!

@Rachael-Graham
Rachael-Graham merged commit 538fc6b into kagent-dev:main Oct 12, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: add Codex and Claude Harness examples, and a codex runtime-image conref

2 participants