iron-core 0.1.38

Core AgentIron loop, session state, and tool registry
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
//! Skill discovery backends for filesystem and in-memory sources.
//!
//! Sources separate lightweight discovery from full loading. Filesystem
//! sources parse `SKILL.md`, snapshot its instruction body and resources, and
//! retain diagnostics; static sources provide the same lifecycle for skills
//! supplied by an embedding client.

use crate::skill::{
    LoadedSkill, SkillDiagnostic, SkillLocation, SkillMetadata, SkillOrigin, SkillResourceEntry,
};
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use tracing::{debug, warn};

/// A source that can discover and load skills.
pub trait SkillSource: Send + Sync {
    /// Discover available skills from this source.
    ///
    /// Returns a map of skill names to metadata. The source may not load
    /// full skill bodies at this stage.
    fn discover(&self) -> HashMap<String, SkillMetadata>;

    /// Load a full skill by name.
    ///
    /// Returns `None` if the skill is not found or cannot be loaded. A loaded
    /// value is an owned snapshot suitable for session-scoped activation.
    fn load(&self, name: &str) -> Option<LoadedSkill>;

    /// Return any diagnostics accumulated during discovery/load.
    ///
    /// Default implementation returns an empty vector.
    fn diagnostics(&self) -> Vec<SkillDiagnostic> {
        Vec::new()
    }
}

/// A skill source that scans filesystem directories for skill directories.
///
/// Each skill directory must contain a `SKILL.md` file with YAML frontmatter.
pub struct FilesystemSkillSource {
    root: PathBuf,
    origin: SkillOrigin,
    diagnostics: std::sync::Mutex<Vec<SkillDiagnostic>>,
}

#[derive(serde::Deserialize)]
struct SkillFrontmatter {
    id: Option<String>,
    #[serde(alias = "name")]
    display_name: String,
    description: String,
    #[serde(default)]
    auto_activate: bool,
    #[serde(default)]
    tags: Vec<String>,
    #[serde(default)]
    requires_tools: Vec<String>,
    #[serde(default)]
    requires_capabilities: Vec<String>,
    #[serde(default)]
    requires_trust: bool,
}

impl SkillFrontmatter {
    fn into_metadata(self, derived_id: String, origin: SkillOrigin) -> SkillMetadata {
        SkillMetadata {
            id: self.id.unwrap_or(derived_id),
            display_name: self.display_name,
            description: self.description,
            origin,
            auto_activate: self.auto_activate,
            tags: self.tags,
            requires_tools: self.requires_tools,
            requires_capabilities: self.requires_capabilities,
            requires_trust: self.requires_trust,
        }
    }
}

impl FilesystemSkillSource {
    /// Create a new filesystem skill source.
    pub fn new(root: impl Into<PathBuf>, origin: SkillOrigin) -> Self {
        Self {
            root: root.into(),
            origin,
            diagnostics: std::sync::Mutex::new(Vec::new()),
        }
    }

    /// Get the root directory being scanned.
    pub fn root(&self) -> &Path {
        &self.root
    }

    /// Parse a SKILL.md file into metadata and body.
    fn parse_skill_file(
        &self,
        path: &Path,
    ) -> Option<(SkillMetadata, String, Vec<SkillResourceEntry>)> {
        let content = std::fs::read_to_string(path).ok()?;

        // Split frontmatter from body
        let (frontmatter, body) = split_frontmatter(&content)?;
        let derived_id = derive_skill_id(path);

        // Parse YAML frontmatter
        let metadata: SkillMetadata = match serde_yaml::from_str::<SkillFrontmatter>(frontmatter) {
            Ok(m) => m.into_metadata(derived_id, self.origin),
            Err(e) => {
                warn!(path = %path.display(), error = %e, "Failed to parse skill frontmatter, using fallback metadata");
                let skill_name = derive_skill_id(path);
                self.diagnostics.lock().unwrap().push(SkillDiagnostic {
                    level: crate::skill::DiagnosticLevel::Warning,
                    message: format!(
                        "Failed to parse frontmatter for '{}': {}. Using fallback metadata.",
                        skill_name, e
                    ),
                    skill_name: Some(skill_name.clone()),
                });
                SkillMetadata {
                    id: skill_name.clone(),
                    display_name: skill_name.clone(),
                    description: format!("Skill '{}' with unparsable frontmatter", skill_name),
                    origin: self.origin,
                    auto_activate: false,
                    tags: Vec::new(),
                    requires_tools: Vec::new(),
                    requires_capabilities: Vec::new(),
                    requires_trust: false,
                }
            }
        };

        // Discover resources
        let resources = self.discover_resources(path.parent()?);

        Some((metadata, body.to_string(), resources))
    }

    /// Discover resource files in the skill directory.
    fn discover_resources(&self, skill_dir: &Path) -> Vec<SkillResourceEntry> {
        let resources_dir = skill_dir.join("resources");
        if !resources_dir.exists() || !resources_dir.is_dir() {
            return Vec::new();
        }

        let mut resources = Vec::new();
        if let Ok(entries) = std::fs::read_dir(&resources_dir) {
            for entry in entries.flatten() {
                let path = entry.path();
                if path.is_file() {
                    let rel_path = path
                        .strip_prefix(&resources_dir)
                        .unwrap_or(&path)
                        .to_string_lossy()
                        .to_string();
                    resources.push(SkillResourceEntry {
                        path: rel_path,
                        description: String::new(), // Could be enhanced with .md sidecars
                    });
                }
            }
        }
        resources
    }
}

impl SkillSource for FilesystemSkillSource {
    fn discover(&self) -> HashMap<String, SkillMetadata> {
        let mut skills = HashMap::new();

        if !self.root.exists() || !self.root.is_dir() {
            return skills;
        }

        let entries = match std::fs::read_dir(&self.root) {
            Ok(e) => e,
            Err(e) => {
                warn!(root = %self.root.display(), error = %e, "Failed to read skills directory");
                return skills;
            }
        };

        for entry in entries.flatten() {
            let path = entry.path();
            if !path.is_dir() {
                continue;
            }

            let skill_file = path.join("SKILL.md");
            if !skill_file.exists() {
                continue;
            }

            if let Some((mut metadata, _, _)) = self.parse_skill_file(&skill_file) {
                // Ensure origin matches the source
                metadata.origin = self.origin;
                skills.insert(metadata.id.clone(), metadata);
            }
        }

        debug!(count = skills.len(), root = %self.root.display(), "Discovered skills");
        skills
    }

    fn load(&self, name: &str) -> Option<LoadedSkill> {
        let skill_dir = self.root.join(name);
        let skill_file = skill_dir.join("SKILL.md");

        if !skill_file.exists() {
            return None;
        }

        let (mut metadata, body, resources) = self.parse_skill_file(&skill_file)?;
        metadata.origin = self.origin;

        Some(LoadedSkill {
            metadata,
            location: Some(SkillLocation {
                directory: skill_dir.clone(),
                skill_file,
                resources_dir: skill_dir
                    .join("resources")
                    .exists()
                    .then(|| skill_dir.join("resources")),
            }),
            body,
            resources,
        })
    }

    fn diagnostics(&self) -> Vec<SkillDiagnostic> {
        self.diagnostics.lock().unwrap().drain(..).collect()
    }
}

/// A skill source backed by statically-provided skills.
///
/// Useful for client-provided or bundled skills that don't exist on disk.
pub struct StaticSkillSource {
    skills: HashMap<String, LoadedSkill>,
}

impl StaticSkillSource {
    /// Create a new empty static skill source.
    pub fn new() -> Self {
        Self {
            skills: HashMap::new(),
        }
    }

    /// Register or replace a skill with this source by metadata ID.
    pub fn register(&mut self, skill: LoadedSkill) {
        self.skills.insert(skill.metadata.id.clone(), skill);
    }

    /// Register or replace a client-provided skill from raw components.
    ///
    /// The created skill has no filesystem location, resources, trust
    /// requirement, or automatic activation.
    pub fn register_raw(
        &mut self,
        name: impl Into<String>,
        description: impl Into<String>,
        body: impl Into<String>,
    ) {
        let name = name.into();
        let skill = LoadedSkill {
            metadata: SkillMetadata {
                id: name.clone(),
                display_name: name.clone(),
                description: description.into(),
                origin: SkillOrigin::ClientProvided,
                auto_activate: false,
                tags: Vec::new(),
                requires_tools: Vec::new(),
                requires_capabilities: Vec::new(),
                requires_trust: false,
            },
            location: None,
            body: body.into(),
            resources: Vec::new(),
        };
        self.skills.insert(name, skill);
    }
}

impl Default for StaticSkillSource {
    fn default() -> Self {
        Self::new()
    }
}

impl SkillSource for StaticSkillSource {
    fn discover(&self) -> HashMap<String, SkillMetadata> {
        self.skills
            .values()
            .map(|s| (s.metadata.id.clone(), s.metadata.clone()))
            .collect()
    }

    fn load(&self, name: &str) -> Option<LoadedSkill> {
        self.skills.get(name).cloned()
    }
}

fn derive_skill_id(path: &Path) -> String {
    path.parent()
        .and_then(|p| p.file_name())
        .or_else(|| path.file_stem())
        .and_then(|n| n.to_str())
        .unwrap_or("unknown")
        .to_string()
}

/// Split markdown content into YAML frontmatter and body.
///
/// Expects frontmatter delimited by `---` at the start of the file.
fn split_frontmatter(content: &str) -> Option<(&str, &str)> {
    let content = content.trim_start();

    // Check for --- delimiter
    if !content.starts_with("---") {
        // No frontmatter - entire content is body
        return Some(("", content));
    }

    // Find the closing ---
    let after_open = &content[3..];
    let close_idx = after_open.find("---")?;

    let frontmatter = after_open[..close_idx].trim();
    let body = after_open[close_idx + 3..].trim_start();

    Some((frontmatter, body))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn split_frontmatter_with_valid_delimiters() {
        let content = "---\nname: test\n---\n# Body\nContent here.";
        let (frontmatter, body) = split_frontmatter(content).unwrap();
        assert_eq!(frontmatter.trim(), "name: test");
        assert_eq!(body, "# Body\nContent here.");
    }

    #[test]
    fn split_frontmatter_without_delimiters() {
        let content = "# Just body\nNo frontmatter.";
        let (frontmatter, body) = split_frontmatter(content).unwrap();
        assert_eq!(frontmatter, "");
        assert_eq!(body, "# Just body\nNo frontmatter.");
    }

    #[test]
    fn static_source_register_and_load() {
        let mut source = StaticSkillSource::new();
        source.register_raw(
            "test-skill",
            "A test skill",
            "# Instructions\nDo something.",
        );

        let skills = source.discover();
        assert_eq!(skills.len(), 1);
        assert!(skills.contains_key("test-skill"));

        let loaded = source.load("test-skill").unwrap();
        assert_eq!(loaded.metadata.display_name, "test-skill");
        assert_eq!(loaded.body, "# Instructions\nDo something.");
    }

    #[test]
    fn filesystem_source_discovers_skills_from_directory() {
        let temp_dir =
            std::env::temp_dir().join(format!("iron-core-test-skills-{}", std::process::id()));
        let _ = std::fs::remove_dir_all(&temp_dir);

        // Create a skill directory with a valid SKILL.md
        let skill_dir = temp_dir.join("test-skill");
        std::fs::create_dir_all(&skill_dir).unwrap();
        std::fs::write(
            skill_dir.join("SKILL.md"),
            "---\nid: test-skill\nname: Test Skill\ndescription: A test skill\n---\n# Instructions\nDo something."
        ).unwrap();

        let source = FilesystemSkillSource::new(&temp_dir, SkillOrigin::ProjectFilesystem);
        let skills = source.discover();

        assert_eq!(skills.len(), 1);
        assert!(skills.contains_key("test-skill"));
        let metadata = skills.get("test-skill").unwrap();
        assert_eq!(metadata.display_name, "Test Skill");
        assert_eq!(metadata.description, "A test skill");

        let loaded = source.load("test-skill").unwrap();
        assert_eq!(loaded.body, "# Instructions\nDo something.");

        let _ = std::fs::remove_dir_all(&temp_dir);
    }

    #[test]
    fn filesystem_source_derives_missing_id_from_skill_directory() {
        let temp_dir = std::env::temp_dir().join(format!(
            "iron-core-test-skills-missing-id-{}",
            std::process::id()
        ));
        let _ = std::fs::remove_dir_all(&temp_dir);

        let skill_dir = temp_dir.join("architecture-patterns");
        std::fs::create_dir_all(&skill_dir).unwrap();
        std::fs::write(
            skill_dir.join("SKILL.md"),
            "---\nname: architecture-patterns\ndescription: Implement backend architecture patterns\nrequires_trust: true\n---\n# Instructions\nDo something.",
        )
        .unwrap();

        let source = FilesystemSkillSource::new(&temp_dir, SkillOrigin::ProjectFilesystem);
        let skills = source.discover();

        assert_eq!(skills.len(), 1);
        assert!(skills.contains_key("architecture-patterns"));
        let metadata = skills.get("architecture-patterns").unwrap();
        assert_eq!(metadata.id, "architecture-patterns");
        assert_eq!(metadata.display_name, "architecture-patterns");
        assert_eq!(
            metadata.description,
            "Implement backend architecture patterns"
        );
        assert!(metadata.requires_trust);
        assert!(source.diagnostics().is_empty());

        let loaded = source.load("architecture-patterns").unwrap();
        assert_eq!(loaded.metadata.id, "architecture-patterns");
        assert_eq!(loaded.body, "# Instructions\nDo something.");

        let _ = std::fs::remove_dir_all(&temp_dir);
    }

    #[test]
    fn filesystem_source_preserves_explicit_id() {
        let temp_dir = std::env::temp_dir().join(format!(
            "iron-core-test-skills-explicit-id-{}",
            std::process::id()
        ));
        let _ = std::fs::remove_dir_all(&temp_dir);

        let skill_dir = temp_dir.join("folder-name");
        std::fs::create_dir_all(&skill_dir).unwrap();
        std::fs::write(
            skill_dir.join("SKILL.md"),
            "---\nid: explicit-id\nname: Explicit Skill\ndescription: A test skill\n---\n# Instructions",
        )
        .unwrap();

        let source = FilesystemSkillSource::new(&temp_dir, SkillOrigin::ProjectFilesystem);
        let skills = source.discover();

        assert_eq!(skills.len(), 1);
        assert!(skills.contains_key("explicit-id"));
        assert!(!skills.contains_key("folder-name"));
        assert!(source.diagnostics().is_empty());

        let _ = std::fs::remove_dir_all(&temp_dir);
    }

    #[test]
    fn filesystem_source_handles_malformed_yaml_gracefully() {
        let temp_dir =
            std::env::temp_dir().join(format!("iron-core-test-malformed-{}", std::process::id()));
        let _ = std::fs::remove_dir_all(&temp_dir);

        // Create a skill directory with malformed YAML frontmatter
        let skill_dir = temp_dir.join("bad-skill");
        std::fs::create_dir_all(&skill_dir).unwrap();
        std::fs::write(
            skill_dir.join("SKILL.md"),
            "---\nthis is not: valid: yaml: [\n---\n# Instructions\nDo something.",
        )
        .unwrap();

        let source = FilesystemSkillSource::new(&temp_dir, SkillOrigin::ProjectFilesystem);
        let skills = source.discover();

        // Should still discover the skill with fallback metadata
        assert_eq!(skills.len(), 1);
        assert!(skills.contains_key("bad-skill"));
        let metadata = skills.get("bad-skill").unwrap();
        assert_eq!(metadata.display_name, "bad-skill");
        assert!(metadata.description.contains("unparsable"));

        // Should have recorded a diagnostic
        let diagnostics = source.diagnostics();
        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].level, crate::skill::DiagnosticLevel::Warning);
        assert!(diagnostics[0]
            .message
            .contains("Failed to parse frontmatter"));

        let _ = std::fs::remove_dir_all(&temp_dir);
    }

    #[test]
    fn filesystem_source_skips_directories_without_skill_md() {
        let temp_dir =
            std::env::temp_dir().join(format!("iron-core-test-empty-{}", std::process::id()));
        let _ = std::fs::remove_dir_all(&temp_dir);

        // Create a directory without SKILL.md
        let empty_dir = temp_dir.join("empty-dir");
        std::fs::create_dir_all(&empty_dir).unwrap();
        std::fs::write(empty_dir.join("README.md"), "# Not a skill").unwrap();

        let source = FilesystemSkillSource::new(&temp_dir, SkillOrigin::ProjectFilesystem);
        let skills = source.discover();

        assert_eq!(skills.len(), 0);

        let _ = std::fs::remove_dir_all(&temp_dir);
    }
}