Should OKF replace AGENTS.md?
No. They answer different questions.
Comparison
OKF vs AGENTS.md
Use AGENTS.md to instruct a coding agent inside a repo; use OKF to package reusable knowledge that can outlive one coding session.
Quick comparison
Question
OKF
Other concept
One-sentence conclusion
Packages reusable Markdown knowledge files with frontmatter.
Use AGENTS.md to instruct a coding agent inside a repo; use OKF to package reusable knowledge that can outlive one coding session.
What it is
A draft format for structured knowledge bundles.
AGENTS.md is commonly used to tell coding agents how to work in a repository: commands, style rules, safety boundaries, and project-specific conventions.
Where it fits
Portable docs, API context, data notes, support playbooks, and agent context.
Repository setup notes for coding agents.
Use together?
Can link to or describe the other artifact.
Yes. AGENTS.md can tell an agent to read a local OKF bundle before changing docs, support content, or data catalog files.
One-sentence conclusion
Use AGENTS.md to instruct a coding agent inside a repo; use OKF to package reusable knowledge that can outlive one coding session.
What it is
AGENTS.md is commonly used to tell coding agents how to work in a repository: commands, style rules, safety boundaries, and project-specific conventions.
Where it fits
- Repository setup notes for coding agents.
- Build, test, commit, and review instructions.
- Local workflow constraints that should apply while editing code.
Key differences
- OKF models knowledge concepts; AGENTS.md models agent behavior in a repo.
- OKF can be shared as a bundle; AGENTS.md is usually tied to one codebase.
- OKF files can describe products, docs, data, and support; AGENTS.md focuses on how an agent should operate.
Can they work together
Yes. AGENTS.md can tell an agent to read a local OKF bundle before changing docs, support content, or data catalog files.
Example workflow
- Create OKF files for product concepts and documentation topics.
- Add AGENTS.md instructions that point coding agents to the OKF folder.
- Ask the agent to validate OKF frontmatter before opening a pull request.
FAQ
Can AGENTS.md reference OKF files?
Yes. That is a practical way to route an agent toward maintained context.
Should secrets go in either file?
No. Keep credentials and private customer data out of both.
Related pages
- OKF Validator for checking frontmatter.
- OKF Templates for starter files.
- OKF Examples for bundle patterns.
Source boundary
This comparison uses official sources for definitions where available. Workflow recommendations are practical judgments, not official certification.