crabmate 0.4.0

Rust AI agent: OpenAI-compatible chat/completions, function calling, HTTP serve, ops CLI
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
//! 首条 `system` 动态组装(L3 角色基底 + L4 运行时附录 + L5 按轮 Skills)。
//!
//! Web **`build_messages_for_turn`**、CLI REPL/`chat`、会话恢复与角色切换应共用本模块语义。

use std::path::{Path, PathBuf};
use std::sync::Arc;

use tracing::warn;

use crate::cm_internal::tool_stats::ToolOutcomeRecorder;
use crate::cm_config::AgentConfig;
use crate::cm_types::SessionMode;

/// 保留占位:组装路径恒为 Strict;角色容错见 [`resolve_agent_role_for_prompt_compose`]。
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RoleSystemResolution {
    Strict,
}

fn append_session_mode_appendix(system: String, mode: SessionMode) -> String {
    let body = crate::cm_config::embedded_session_mode_appendix(mode);
    if body.is_empty() {
        return system;
    }
    format!("{}\n\n{}", system.trim_end(), body)
}

fn resolve_role_system_base(cfg: &AgentConfig, agent_role: Option<&str>) -> Result<String, String> {
    cfg.system_prompt_for_new_conversation(agent_role)
        .map(|s| s.to_string())
        .map_err(|e| e.to_string())
}

/// 解析本回合用于组装的命名 `agent_role`。
///
/// - **显式请求**(`request_role` 非空):未知 id → `Err`(Web/CLI/REPL `/agent set` 与三端对齐)。
/// - **仅持久化**(`request_role` 为空、`persisted_role` 非空):配置已删除该 id 时 `warn` 并退回 `None`(默认人格)。
pub fn resolve_agent_role_for_prompt_compose(
    cfg: &AgentConfig,
    request_role: Option<&str>,
    persisted_role: Option<&str>,
) -> Result<Option<String>, String> {
    if let Some(id) = request_role.map(str::trim).filter(|s| !s.is_empty()) {
        cfg.system_prompt_for_new_conversation(Some(id))
            .map_err(|e| e.to_string())?;
        return Ok(Some(id.to_string()));
    }
    if let Some(id) = persisted_role.map(str::trim).filter(|s| !s.is_empty()) {
        if cfg.system_prompt_for_new_conversation(Some(id)).is_ok() {
            return Ok(Some(id.to_string()));
        }
        warn!(
            target: "crabmate",
            agent_role = %id,
            "persisted agent_role no longer in config; using default persona for prompt compose"
        );
        return Ok(None);
    }
    Ok(None)
}

/// L5:按当前用户输入从工作区 skills 目录选材时的上下文。
pub struct SkillsComposeContext<'a> {
    pub base_dir: &'a Path,
    pub user_text: &'a str,
    /// 用户通过 `/<id>` 显式选用的 skill;若设置则跳过 Top-K。
    pub forced_skill: Option<crate::cm_config::skills::SkillDoc>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct FirstSystemComposeDiagnostics {
    pub layers_applied: Vec<String>,
    pub chars_l3_base: usize,
    pub chars_l4_augmented: usize,
    pub chars_final: usize,
    pub skills_total_docs: usize,
    pub skills_selected_labels: Vec<String>,
}

/// Web / CLI 共用的 skills 扫描根:空工作区路径时回落进程 `cwd`。
#[must_use]
pub fn resolve_skills_base_dir(workspace_root: &Path) -> PathBuf {
    if workspace_root.as_os_str().is_empty() {
        std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."))
    } else {
        workspace_root.to_path_buf()
    }
}

/// 在已解析的 L3 基底上叠加 L4(思维链附录、工具统计)与可选 L5(Skills top-k)。
pub fn compose_system_from_base(
    base_system: &str,
    cfg: &AgentConfig,
    tool_recorder: &ToolOutcomeRecorder,
    skills: Option<SkillsComposeContext<'_>>,
) -> String {
    let augmented = tool_recorder.augment_system_prompt(base_system, cfg);
    merge_skills_into_system(augmented, cfg, skills)
}

/// 从配置解析 L3,再叠加 L4 + 可选 L5。
pub fn compose_system_for_turn(
    cfg: &AgentConfig,
    agent_role: Option<&str>,
    tool_recorder: &ToolOutcomeRecorder,
    skills: Option<SkillsComposeContext<'_>>,
    _role_resolution: RoleSystemResolution,
) -> Result<String, String> {
    let base = resolve_role_system_base(cfg, agent_role)?;
    Ok(compose_system_from_base(&base, cfg, tool_recorder, skills))
}

/// 首条 `system` 组装参数(L3 基底 + L4 + 可选 L5 + 会话模式附录)。`agent_role` 须经 [`resolve_agent_role_for_prompt_compose`] 解析后再传入。
pub struct FirstSystemComposeOpts<'a> {
    pub agent_role: Option<&'a str>,
    pub user_msg_for_skills: Option<&'a str>,
    pub skills_base_dir: Option<PathBuf>,
    /// 用户 `/<id>` 强制选用的 skill(与 [`SkillsComposeContext::forced_skill`] 同源)。
    pub forced_skill: Option<crate::cm_config::skills::SkillDoc>,
    /// 保留字段;实现恒按 [`RoleSystemResolution::Strict`] 解析已传入的 `agent_role`。
    pub role_resolution: RoleSystemResolution,
    /// 会话工作模式附录;`None` 时用配置 `default_session_mode`。
    pub session_mode: Option<SessionMode>,
}

/// Web / CLI 续聊刷新首条 `system` 的统一入口(L3 + L4 + 可选 L5)。
pub fn compose_first_system_for_turn(
    cfg: &AgentConfig,
    tool_recorder: &Arc<ToolOutcomeRecorder>,
    opts: FirstSystemComposeOpts<'_>,
) -> Result<String, String> {
    let (merged, _) = compose_first_system_for_turn_with_diagnostics(cfg, tool_recorder, opts)?;
    Ok(merged)
}

pub fn compose_first_system_for_turn_with_diagnostics(
    cfg: &AgentConfig,
    tool_recorder: &Arc<ToolOutcomeRecorder>,
    opts: FirstSystemComposeOpts<'_>,
) -> Result<(String, FirstSystemComposeDiagnostics), String> {
    debug_assert_eq!(
        opts.role_resolution,
        RoleSystemResolution::Strict,
        "pass pre-resolved agent_role via resolve_agent_role_for_prompt_compose"
    );
    let FirstSystemComposeOpts {
        agent_role,
        user_msg_for_skills,
        skills_base_dir,
        forced_skill,
        role_resolution: _,
        session_mode,
    } = opts;
    let skills_ctx = skills_base_dir
        .as_ref()
        .zip(user_msg_for_skills)
        .map(|(base, user)| SkillsComposeContext {
            base_dir: base.as_path(),
            user_text: user,
            forced_skill,
        });
    let base = resolve_role_system_base(cfg, agent_role)?;
    let augmented = tool_recorder.augment_system_prompt(&base, cfg);
    let chars_l4_augmented = augmented.chars().count();
    let (merged, skills_meta) = merge_skills_into_system_with_meta(augmented, cfg, skills_ctx);
    let mode = session_mode.unwrap_or(cfg.roles_prompts.default_session_mode);
    let merged = append_session_mode_appendix(merged, mode);
    let chars_final = merged.chars().count();
    let mut layers = vec!["L3".to_string(), "L4".to_string()];
    if !skills_meta.selected_labels.is_empty() {
        layers.push("L5".to_string());
    }
    layers.push("mode".to_string());
    Ok((
        merged,
        FirstSystemComposeDiagnostics {
            layers_applied: layers,
            chars_l3_base: base.chars().count(),
            chars_l4_augmented,
            chars_final,
            skills_total_docs: skills_meta.total_docs,
            skills_selected_labels: skills_meta.selected_labels,
        },
    ))
}

/// 与 [`compose_system_for_turn`] 相同,但 `tool_recorder` 为 `Arc`(Web handler 常用)。
pub fn compose_system_for_turn_arc(
    cfg: &AgentConfig,
    agent_role: Option<&str>,
    tool_recorder: &Arc<ToolOutcomeRecorder>,
    skills: Option<SkillsComposeContext<'_>>,
    role_resolution: RoleSystemResolution,
) -> Result<String, String> {
    compose_system_for_turn(
        cfg,
        agent_role,
        tool_recorder.as_ref(),
        skills,
        role_resolution,
    )
}

fn merge_skills_into_system(
    system_prompt: String,
    cfg: &AgentConfig,
    skills: Option<SkillsComposeContext<'_>>,
) -> String {
    merge_skills_into_system_with_meta(system_prompt, cfg, skills).0
}

fn merge_skills_into_system_with_meta(
    system_prompt: String,
    cfg: &AgentConfig,
    skills: Option<SkillsComposeContext<'_>>,
) -> (String, crate::cm_config::skills::SkillsSelectionMeta) {
    let Some(sk) = skills else {
        return (
            system_prompt,
            crate::cm_config::skills::SkillsSelectionMeta::default(),
        );
    };
    crate::cm_config::skills::merge_system_prompt_with_skills_selected_with_meta(
        system_prompt.clone(),
        crate::cm_config::skills::SkillsSelectedMergeOpts {
            skills_enabled: cfg.skills.skills_enabled,
            skills_dir: cfg.skills.skills_dir.as_str(),
            skills_user_dir: cfg.skills.skills_user_dir.as_str(),
            skills_system_dir: cfg.skills.skills_system_dir.as_str(),
            skills_max_chars: cfg.skills.skills_max_chars,
            base_dir: sk.base_dir,
            user_text: sk.user_text,
            top_k: cfg.skills.skills_top_k,
            forced_skill: sk.forced_skill.as_ref(),
        },
    )
    .unwrap_or((
        system_prompt,
        crate::cm_config::skills::SkillsSelectionMeta::default(),
    ))
}

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

    fn embed_default_config() -> crate::cm_config::AgentConfig {
        crate::cm_config::load_config_test_env::without_cm_planner_executor_mode_env(|| {
            crate::cm_config::load_config(None).expect("embed default")
        })
    }

    #[test]
    fn resolve_persisted_unknown_role_falls_back_to_default() {
        let cfg = embed_default_config();
        let role =
            resolve_agent_role_for_prompt_compose(&cfg, None, Some("nonexistent_role_id_xyz"))
                .expect("persisted unknown should not error");
        assert_eq!(role, None);
    }

    #[test]
    fn resolve_explicit_unknown_role_errors() {
        let cfg = embed_default_config();
        let err =
            resolve_agent_role_for_prompt_compose(&cfg, Some("nonexistent_role_id_xyz"), None)
                .expect_err("explicit unknown");
        assert!(err.contains("未知的 agent_role"));
    }

    #[test]
    fn compose_lenient_unknown_role_falls_back_to_global_system() {
        let cfg = embed_default_config();
        let rec = ToolOutcomeRecorder::new();
        let role =
            resolve_agent_role_for_prompt_compose(&cfg, None, Some("nonexistent_role_id_xyz"))
                .expect("persisted");
        let out = compose_system_for_turn(
            &cfg,
            role.as_deref(),
            &rec,
            None,
            RoleSystemResolution::Strict,
        )
        .expect("compose");
        assert!(!out.trim().is_empty());
        let global = cfg.roles_prompts.system_prompt.trim();
        assert!(
            out.contains(global),
            "resolved default compose should include global system prompt"
        );
    }

    #[test]
    fn compose_strict_unknown_role_errors() {
        let cfg = embed_default_config();
        let err =
            resolve_agent_role_for_prompt_compose(&cfg, Some("nonexistent_role_id_xyz"), None)
                .expect_err("strict resolve");
        assert!(err.contains("未知的 agent_role"));
    }

    #[test]
    fn compose_from_base_without_skills_matches_augment_only() {
        let cfg = embed_default_config();
        let rec = ToolOutcomeRecorder::new();
        let base = "BASE_PROMPT_MARKER";
        let expected = rec.augment_system_prompt(base, &cfg);
        let got = compose_system_from_base(base, &cfg, &rec, None);
        assert_eq!(got, expected);
    }

    #[test]
    fn compose_first_system_diagnostics_without_skills_reports_l3_l4_only() {
        let cfg = embed_default_config();
        let rec = Arc::new(ToolOutcomeRecorder::new());
        let (_system, diag) = compose_first_system_for_turn_with_diagnostics(
            &cfg,
            &rec,
            FirstSystemComposeOpts {
                agent_role: None,
                user_msg_for_skills: None,
                skills_base_dir: None,
                forced_skill: None,
                role_resolution: RoleSystemResolution::Strict,
                session_mode: None,
            },
        )
        .expect("compose");
        assert_eq!(
            diag.layers_applied,
            vec!["L3".to_string(), "L4".to_string(), "mode".to_string()]
        );
        assert!(diag.chars_l3_base > 0);
        assert!(diag.chars_l4_augmented >= diag.chars_l3_base);
        assert_eq!(diag.skills_total_docs, 0);
        assert!(diag.skills_selected_labels.is_empty());
    }

    #[test]
    fn compose_first_system_diagnostics_with_skills_reports_l5_selection() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let skills_dir = tmp.path().join(".crabmate/skills");
        std::fs::create_dir_all(&skills_dir).expect("create skills dir");
        let mut f = std::fs::File::create(skills_dir.join("rust.md")).expect("create skill file");
        writeln!(
            f,
            "---\nname: Rust Build Skill\n---\n使用 cargo test 与 cargo clippy 进行验证。"
        )
        .expect("write skill");

        let mut cfg = embed_default_config();
        cfg.skills.skills_enabled = true;
        cfg.skills.skills_dir = ".crabmate/skills".to_string();
        cfg.skills.skills_user_dir.clear();
        cfg.skills.skills_system_dir.clear();
        cfg.skills.skills_top_k = 4;
        let rec = Arc::new(ToolOutcomeRecorder::new());
        let (_system, diag) = compose_first_system_for_turn_with_diagnostics(
            &cfg,
            &rec,
            FirstSystemComposeOpts {
                agent_role: None,
                user_msg_for_skills: Some("请帮我跑 cargo test"),
                skills_base_dir: Some(tmp.path().to_path_buf()),
                forced_skill: None,
                role_resolution: RoleSystemResolution::Strict,
                session_mode: None,
            },
        )
        .expect("compose");
        assert!(diag.layers_applied.contains(&"L5".to_string()));
        assert_eq!(diag.skills_total_docs, 1);
        assert_eq!(diag.skills_selected_labels.len(), 1);
        assert!(diag.skills_selected_labels[0].contains("Rust Build Skill"));
    }

    #[test]
    fn compose_first_system_forced_skill_skips_topk() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let skills_dir = tmp.path().join(".crabmate/skills");
        std::fs::create_dir_all(&skills_dir).expect("create skills dir");
        std::fs::write(
            skills_dir.join("a.md"),
            "---\nname: alpha\n---\nalpha body\n",
        )
        .expect("write a");
        std::fs::write(
            skills_dir.join("b.md"),
            "---\nname: beta\n---\nbeta body cargo\n",
        )
        .expect("write b");
        let forced = crate::cm_config::skills_slash::resolve_skill_by_id(
            crate::cm_config::skills::SkillsListOpts {
                workspace_base_dir: tmp.path(),
                skills_dir: ".crabmate/skills",
                skills_user_dir: "",
                skills_system_dir: "",
            },
            "alpha",
        )
        .expect("resolve");
        let mut cfg = embed_default_config();
        cfg.skills.skills_enabled = true;
        cfg.skills.skills_dir = ".crabmate/skills".to_string();
        cfg.skills.skills_user_dir.clear();
        cfg.skills.skills_system_dir.clear();
        cfg.skills.skills_top_k = 4;
        let rec = Arc::new(ToolOutcomeRecorder::new());
        let (system, diag) = compose_first_system_for_turn_with_diagnostics(
            &cfg,
            &rec,
            FirstSystemComposeOpts {
                agent_role: None,
                user_msg_for_skills: Some("cargo"),
                skills_base_dir: Some(tmp.path().to_path_buf()),
                forced_skill: Some(forced),
                role_resolution: RoleSystemResolution::Strict,
                session_mode: None,
            },
        )
        .expect("compose");
        assert!(system.contains("alpha body"));
        assert!(!system.contains("beta body"));
        assert!(diag.skills_selected_labels[0].contains("[forced]"));
    }
}