mofa-sdk 0.1.0

MoFA SDK - Modular Framework for Agents. A standard development toolkit for building AI agents with Rust
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
//! Skills Manager - SDK 层统一 API

use super::{DisclosureController, RequirementCheck, SkillMetadata};
use std::path::{Path, PathBuf};

/// Skills Manager - SDK 层统一 API
///
/// 提供 Skills 的管理和查询接口,支持渐进式披露、多目录搜索和依赖检查。
#[derive(Debug, Clone)]
pub struct SkillsManager {
    controller: DisclosureController,
}

impl SkillsManager {
    /// 创建新的 Skills Manager(单目录)
    ///
    /// # Arguments
    ///
    /// * `skills_dir` - Skills 目录路径
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use mofa_sdk::skills::SkillsManager;
    ///
    /// let manager = SkillsManager::new("./skills").unwrap();
    /// ```
    pub fn new(skills_dir: impl AsRef<Path>) -> anyhow::Result<Self> {
        let skills_dir = skills_dir.as_ref();

        // 不要求目录必须存在(支持空目录)
        let mut controller = DisclosureController::new(skills_dir);
        if skills_dir.exists() {
            controller.scan_metadata()?;
        }

        Ok(Self { controller })
    }

    /// 创建支持多目录搜索的 Skills Manager
    ///
    /// # Arguments
    ///
    /// * `search_dirs` - Skills 目录列表,按优先级排序
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use mofa_sdk::skills::SkillsManager;
    /// use std::path::PathBuf;
    ///
    /// let workspace_skills = PathBuf::from("./workspace/skills");
    /// let builtin_skills = SkillsManager::find_builtin_skills();
    ///
    /// if let Some(builtin) = builtin_skills {
    ///     let manager = SkillsManager::with_search_dirs(vec![workspace_skills, builtin]).unwrap();
    /// }
    /// ```
    pub fn with_search_dirs(search_dirs: Vec<PathBuf>) -> anyhow::Result<Self> {
        let controller = DisclosureController::with_search_dirs(search_dirs);
        let mut manager = Self { controller };
        manager.rescan()?;
        Ok(manager)
    }

    /// 查找内置 skills 目录
    ///
    /// 按以下顺序查找:
    /// 1. CARGO_MANIFEST_DIR/skills(开发时)
    /// 2. 可执行文件父目录/skills(已安装)
    /// 3. /usr/local/lib/mofa/skills(标准安装路径)
    pub fn find_builtin_skills() -> Option<PathBuf> {
        DisclosureController::find_builtin_skills()
    }

    /// 获取系统提示(第1层:仅元数据)
    ///
    /// 返回包含所有 Skills 元数据的系统提示字符串。
    pub fn build_system_prompt(&self) -> String {
        self.controller.build_system_prompt()
    }

    /// 获取系统提示(异步版本)
    pub async fn build_system_prompt_async(&self) -> String {
        self.build_system_prompt()
    }

    /// 加载 Skill 的 SKILL.md 内容(第2层)
    ///
    /// # Arguments
    ///
    /// * `name` - Skill 名称
    ///
    /// # Returns
    ///
    /// 返回 SKILL.md 的 Markdown 内容(去除 frontmatter)
    pub fn load_skill(&self, name: &str) -> Option<String> {
        let skill_path = self.controller.get_skill_path(name)?;
        let skill_md = skill_path.join("SKILL.md");

        let content = std::fs::read_to_string(&skill_md).ok()?;

        // 去除 frontmatter,返回纯 Markdown
        let parts: Vec<&str> = content.splitn(3, "---").collect();
        if parts.len() >= 3 {
            Some(parts[2].trim().to_string())
        } else {
            Some(content)
        }
    }

    /// 加载 Skill 的 SKILL.md 内容(异步版本)
    pub async fn load_skill_async(&self, name: &str) -> Option<String> {
        let skill_path = self.controller.get_skill_path(name)?;
        let skill_md = skill_path.join("SKILL.md");

        let content = tokio::fs::read_to_string(&skill_md).await.ok()?;

        // 去除 frontmatter,返回纯 Markdown
        let parts: Vec<&str> = content.splitn(3, "---").collect();
        if parts.len() >= 3 {
            Some(parts[2].trim().to_string())
        } else {
            Some(content)
        }
    }

    /// 加载多个 Skills 的内容用于上下文
    ///
    /// # Arguments
    ///
    /// * `skill_names` - Skill 名称列表
    ///
    /// # Returns
    ///
    /// 返回所有 Skills 的 Markdown 内容,用 --- 分隔
    pub async fn load_skills_for_context(&self, skill_names: &[String]) -> String {
        let mut parts = Vec::new();

        for name in skill_names {
            if let Some(content) = self.load_skill_async(name).await
                && !content.is_empty()
            {
                parts.push(format!("### Skill: {}\n\n{}", name, content));
            }
        }

        parts.join("\n\n---\n\n")
    }

    /// 获取标记为 always 的技能名称列表
    pub fn get_always_skills(&self) -> Vec<String> {
        self.controller.get_always_skills()
    }

    /// 获取标记为 always 的技能名称列表(异步版本)
    pub async fn get_always_skills_async(&self) -> Vec<String> {
        self.get_always_skills()
    }

    /// 检查技能依赖是否满足
    pub fn check_requirements(&self, name: &str) -> RequirementCheck {
        self.controller.check_requirements(name)
    }

    /// 检查技能依赖是否满足(异步版本)
    pub async fn check_requirements_async(&self, name: &str) -> RequirementCheck {
        self.check_requirements(name)
    }

    /// 获取技能的安装指令
    pub fn get_install_instructions(&self, name: &str) -> Option<String> {
        self.controller.get_install_instructions(name)
    }

    /// 获取缺失依赖的描述字符串
    pub fn get_missing_requirements_description(&self, name: &str) -> String {
        self.controller.get_missing_requirements_description(name)
    }

    /// 构建技能摘要 XML 格式
    ///
    /// 返回所有技能的名称、描述、位置和可用性信息
    pub async fn build_skills_summary(&self) -> String {
        let all_metadata = self.get_all_metadata();

        if all_metadata.is_empty() {
            return String::new();
        }

        let mut lines = vec!["<skills>".to_string()];

        for metadata in all_metadata {
            let name = escape_xml(&metadata.name);
            let desc = escape_xml(&metadata.description);
            let path = self
                .controller
                .get_skill_path(&metadata.name)
                .map(|p| p.display().to_string())
                .unwrap_or_default();
            let check = self.check_requirements_async(&metadata.name).await;
            let available = check.satisfied;

            lines.push(format!("  <skill available=\"{}\">", available));
            lines.push(format!("    <name>{}</name>", name));
            lines.push(format!("    <description>{}</description>", desc));
            lines.push(format!("    <location>{}</location>", escape_xml(&path)));

            // Show missing requirements for unavailable skills
            if !available {
                let missing = check
                    .missing
                    .iter()
                    .map(|r| match r {
                        super::Requirement::CliTool(t) => format!("CLI: {}", t),
                        super::Requirement::EnvVar(v) => format!("ENV: {}", v),
                    })
                    .collect::<Vec<_>>()
                    .join(", ");
                if !missing.is_empty() {
                    lines.push(format!("    <requires>{}</requires>", escape_xml(&missing)));
                }
            }

            lines.push("  </skill>".to_string());
        }

        lines.push("</skills>".to_string());

        lines.join("\n")
    }

    /// 获取技能描述
    pub async fn get_skill_description(&self, name: &str) -> String {
        self.get_all_metadata()
            .iter()
            .find(|m| m.name == name)
            .map(|m| {
                if m.description.is_empty() {
                    name.to_string()
                } else {
                    m.description.clone()
                }
            })
            .unwrap_or_else(|| name.to_string())
    }

    /// 获取所有 Skills 的元数据
    pub fn get_all_metadata(&self) -> Vec<SkillMetadata> {
        self.controller.get_all_metadata()
    }

    /// 搜索相关 Skills
    ///
    /// # Arguments
    ///
    /// * `query` - 搜索关键词
    ///
    /// # Returns
    ///
    /// 返回匹配的 Skill 名称列表
    pub fn search(&self, query: &str) -> Vec<String> {
        self.controller.search(query)
    }

    /// 检查 Skill 是否存在
    pub fn has_skill(&self, name: &str) -> bool {
        self.controller.has_skill(name)
    }

    /// 重新扫描 Skills 目录
    pub fn rescan(&mut self) -> anyhow::Result<usize> {
        self.controller.scan_metadata()
    }

    /// 重新扫描 Skills 目录(异步版本)
    pub async fn rescan_async(&mut self) -> anyhow::Result<usize> {
        self.rescan()
    }

    /// 列出所有可用的技能信息
    ///
    /// # Arguments
    ///
    /// * `filter_unavailable` - 是否过滤掉不满足依赖的技能
    pub async fn list_skills(&self, filter_unavailable: bool) -> Vec<SkillInfo> {
        let mut skills = Vec::new();
        let all_metadata = self.get_all_metadata();

        for metadata in all_metadata {
            let name = metadata.name.clone();
            let path = self
                .controller
                .get_skill_path(&name)
                .map(|p| p.display().to_string())
                .unwrap_or_default();
            let source = "skills".to_string();

            if filter_unavailable {
                let check = self.check_requirements_async(&name).await;
                if !check.satisfied {
                    continue;
                }
            }

            skills.push(SkillInfo { name, path, source });
        }

        skills
    }
}

/// 技能信息
#[derive(Debug, Clone)]
pub struct SkillInfo {
    pub name: String,
    pub path: String,
    pub source: String,
}

/// Escape XML 特殊字符
fn escape_xml(s: &str) -> String {
    s.replace('&', "&amp;")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    fn create_test_skill(dir: &Path, name: &str, description: &str) -> std::io::Result<()> {
        let skill_dir = dir.join(name);
        fs::create_dir_all(&skill_dir)?;

        let content = format!(
            r#"---
name: {}
description: {}
category: test
tags: [test]
version: "1.0.0"
---

# {} Skill

This is a test skill."#,
            name, description, name
        );

        fs::write(skill_dir.join("SKILL.md"), content)?;
        Ok(())
    }

    #[test]
    fn test_new_manager() {
        let temp_dir = TempDir::new().unwrap();
        let skills_dir = temp_dir.path();

        create_test_skill(skills_dir, "skill1", "First skill").unwrap();
        create_test_skill(skills_dir, "skill2", "Second skill").unwrap();

        let manager = SkillsManager::new(skills_dir).unwrap();
        assert_eq!(manager.get_all_metadata().len(), 2);
    }

    #[test]
    fn test_new_manager_nonexistent_dir() {
        // Non-existent dirs are now allowed (empty skills list)
        let result = SkillsManager::new("/nonexistent/skills");
        assert!(result.is_ok());
        assert!(result.unwrap().get_all_metadata().is_empty());
    }

    #[test]
    fn test_build_system_prompt() {
        let temp_dir = TempDir::new().unwrap();
        let skills_dir = temp_dir.path();

        create_test_skill(skills_dir, "skill1", "First skill").unwrap();

        let manager = SkillsManager::new(skills_dir).unwrap();
        let prompt = manager.build_system_prompt();
        assert!(prompt.contains("skill1"));
        assert!(prompt.contains("First skill"));
    }

    #[test]
    fn test_load_skill() {
        let temp_dir = TempDir::new().unwrap();
        let skills_dir = temp_dir.path();

        create_test_skill(skills_dir, "skill1", "First skill").unwrap();

        let manager = SkillsManager::new(skills_dir).unwrap();
        let content = manager.load_skill("skill1").unwrap();
        assert!(content.contains("# skill1 Skill"));
        assert!(content.contains("This is a test skill"));
        // 不应该包含 frontmatter
        assert!(!content.contains("name:"));
    }

    #[test]
    fn test_search() {
        let temp_dir = TempDir::new().unwrap();
        let skills_dir = temp_dir.path();

        create_test_skill(skills_dir, "pdf_processing", "Process PDF files").unwrap();
        create_test_skill(skills_dir, "web_scraping", "Scrape web pages").unwrap();

        let manager = SkillsManager::new(skills_dir).unwrap();

        let results = manager.search("pdf");
        assert_eq!(results, vec!["pdf_processing".to_string()]);

        let results = manager.search("web");
        assert_eq!(results, vec!["web_scraping".to_string()]);
    }

    #[test]
    fn test_has_skill() {
        let temp_dir = TempDir::new().unwrap();
        let skills_dir = temp_dir.path();

        create_test_skill(skills_dir, "skill1", "First skill").unwrap();

        let manager = SkillsManager::new(skills_dir).unwrap();
        assert!(manager.has_skill("skill1"));
        assert!(!manager.has_skill("skill2"));
    }
}