Skip to content

siculo/okf-skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Knowledge Format (OKF) Skills

This repository contains a set of portable agent skills for creating and maintaining OKF (Open Knowledge Format) knowledge bundles. The skills work with Claude Code and other coding agents that support the SKILL.md format.

What is OKF?

OKF is a minimal, open format for representing knowledge as a directory of Markdown files with YAML frontmatter. It is designed to be authored by humans, generated by agents, versioned in git, and consumed without bespoke tooling.

The specification is maintained in the GoogleCloudPlatform/knowledge-catalog repository (Apache 2.0). The skills in this repository read SPEC.md from the bundle they operate on, so they always reflect the version of the spec the bundle was built against.

Skills

The skills/ directory contains six portable skills in the SKILL.md format:

Skill Description
create Create a new OKF bundle from source documents
update Add new source documents to an existing bundle
edit Modify a bundle using natural language instructions
reconcile Align a bundle with updated source documents
search Search concepts by query, type, or tags
validate Validate a bundle for OKF conformance

Arguments

Each skill accepts arguments as a string passed by the agent when invoking it:

Skill Arguments
create <source-path> [output:<path>] [git:yes|no]
update <source-path> [bundle:<path>]
edit "<natural language instruction>" [bundle:<path>]
reconcile <source-path> [bundle:<path>]
search <query> [type:<Type>] [tags:<tag>,<tag>] [in:title|description|body|all] [bundle:<path>]
validate [bundle-path]

Typical workflow

# 1. Create a bundle from your documents
create  ./my-docs  output:./my-bundle  git:yes

# 2. Add new documents later
update  ./new-docs  bundle:./my-bundle

# 3. When source documents change, reconcile
reconcile  ./my-docs  bundle:./my-bundle

# 4. Curate and restructure with instructions
edit  "move all concepts tagged 'legacy' into a legacy/ directory"

# 5. Search across concepts
search  revenue  type:Metric

# 6. Validate at any time
validate  ./my-bundle

Self-replicating bundles

When the create skill generates a new bundle, it copies the entire skills/ directory into the bundle root and downloads SPEC.md from the upstream repository. Any bundle is therefore self-maintaining: clone it and all skills are immediately available in any compatible agent.

Git support

All skills that modify a bundle offer to stage and commit changes at the end of each operation. Bundles distributed as git repositories get a full, attributed history of every creation, update, edit, and reconciliation.

Conformance

A bundle is conformant with OKF v0.1 if every non-reserved .md file contains a valid YAML frontmatter block with a non-empty type field. See §9 of the spec for the full conformance rules. The validate skill always reads the SPEC.md present in the bundle, so validation reflects the version of the spec the bundle was built against.

About

IA Agent skills for creating and maintaining OKF (Open Knowledge Format) knowledge bundles from source documents

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors