OKF Workbench

Agent integration

Agent integration

Decision

OKF Workbench does not embed an AI model or call an AI provider. It helps existing coding agents use the bundle by generating portable project instructions.

Supported outputs

AGENTS.md section

AGENTS.md contains concise, always-applicable repository guidance:

<!-- okf-workbench:start -->
## OKF knowledge

- The OKF bundle is located at `knowledge/`.
- Read `knowledge/index.md` before tasks that require project-wide context.
- Update the relevant concept when a change affects durable project knowledge.
- When an `okf` executable is available for a local bundle, prefer it for validation, new-concept planning, and managed-index updates; review `--check` output before `--apply`.
- Preserve unknown YAML frontmatter fields.
- Use bundle-relative Markdown links between concepts.
- Do not add speculative or temporary information to the bundle.
<!-- okf-workbench:end -->

The actual bundle path replaces knowledge/.

The location comes from the selected workspace provider, not from re-parsing a generated path as user input. Legal provider segment identities such as docs:knowledge, literal %2F, spaces, and Unicode are retained exactly in both generated outputs. The provider-safe branch still rejects an empty path, control characters, absolute paths, non-POSIX separators, and empty, . or .. segments. Plain string inputs to the template API continue through the stricter user-input path normalizer, including stable percent decoding and URI-like path rejection.

When the selected OKF bundle is also the workspace root, the generated root AGENTS.md remains repository control metadata and is excluded from OKF concept parsing, validation, indexing, and the graph. A nested AGENTS.md elsewhere in the bundle remains an ordinary concept candidate.

Agent Skill

The default project-local path is:

.agents/skills/maintain-okf-knowledge/SKILL.md

Every .agents/ subtree is excluded from OKF bundle traversal. This prevents a generated Skill from becoming a concept or conformance finding when the selected bundle occupies the workspace root, and avoids charging excluded Skill content against OKF document limits.

The generated frontmatter is compatible with the Agent Skills specification:

---
name: maintain-okf-knowledge
description: Maintain this repository's OKF knowledge bundle. Use when creating or updating durable project knowledge, recording decisions, repairing links, regenerating indexes, or reviewing knowledge quality.
---

The body covers:

The generated Skill treats the CLI as an optional local-filesystem accelerator rather than a prerequisite. It instructs agents to use editor commands and the documented Markdown rules when okf is unavailable or the selected bundle is provider-backed. To avoid unsafe cross-shell interpolation, examples use <bundle-root> and require the agent to replace it with a correctly quoted local path:

okf validate <bundle-root> --format json
okf new <bundle-root> --template decision --title "<title>" --check
okf index <bundle-root> --mode missing --check

Write examples start with --check; the Skill permits replacing it with --apply only after the reported paths and changes have been reviewed. Existing concept Markdown remains directly editable so unknown frontmatter can be preserved.

Safe merge behavior

Existing AGENTS.md

Existing Skill

Why two files

Keeping the AGENTS.md section short avoids permanent context overhead, while the Skill can provide enough detail for reliable OKF maintenance.

Out of scope