skref 1.0.0

Reference implementation of the Agent Skills tooling: validate, read-properties, and to-prompt for SKILL.md skills
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Reference library for Agent Skills.
//!
//! `skref` is a Rust port of the Python [`skills-ref`] reference library. It
//! provides three operations over skill directories that each contain a
//! `SKILL.md` file:
//!
//! * [`validate`] — check a skill directory for correctness.
//! * [`read_properties`] — parse a skill's frontmatter into [`SkillProperties`].
//! * [`to_prompt`] — render the `<available_skills>` XML block for agent prompts.
//!
//! ```no_run
//! use std::path::Path;
//! use skref::{validate, read_properties, to_prompt};
//!
//! let problems = validate(Path::new("my-skill"));
//! if problems.is_empty() {
//!     let props = read_properties(Path::new("my-skill")).unwrap();
//!     println!("Skill: {} - {}", props.name, props.description);
//! }
//!
//! let prompt = to_prompt(&[Path::new("skill-a"), Path::new("skill-b")]).unwrap();
//! println!("{prompt}");
//! ```
//!
//! [`skills-ref`]: https://github.com/agentskills/agentskills/tree/main/skills-ref

pub mod errors;
pub mod models;
pub mod parser;
pub mod prompt;
pub mod validator;
pub mod yaml;

pub use errors::{Result, SkillError};
pub use models::SkillProperties;
pub use parser::{find_skill_md, parse_frontmatter, read_properties};
pub use prompt::to_prompt;
pub use validator::{validate, validate_metadata};