sxmc 1.0.9

Sumac: bring out what your tools can do — bridge skills, MCP, and APIs into reusable agent, terminal, and automation workflows
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
use std::path::PathBuf;

use clap::ValueEnum;
use serde::{Deserialize, Serialize};

pub const PROFILE_SCHEMA: &str = "sxmc_cli_surface_profile_v1";
pub const CLI_AI_HOSTS_LAST_VERIFIED: &str = "2026-03-21";

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CliSurfaceProfile {
    #[serde(default)]
    pub profile_schema: String,
    #[serde(default)]
    pub command: String,
    #[serde(default)]
    pub summary: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(default)]
    pub source: ProfileSource,
    #[serde(default)]
    pub subcommands: Vec<ProfileSubcommand>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub subcommand_profiles: Vec<CliSurfaceProfile>,
    #[serde(default)]
    pub options: Vec<ProfileOption>,
    #[serde(default)]
    pub positionals: Vec<ProfilePositional>,
    #[serde(default)]
    pub examples: Vec<ProfileExample>,
    #[serde(default)]
    pub auth: Vec<AuthRequirement>,
    #[serde(default)]
    pub environment: Vec<EnvironmentRequirement>,
    #[serde(default)]
    pub output_behavior: OutputBehavior,
    #[serde(default)]
    pub workflows: Vec<Workflow>,
    #[serde(default)]
    pub interactive: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub interactive_reasons: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub non_interactive_alternatives: Vec<String>,
    #[serde(default)]
    pub confidence_notes: Vec<ConfidenceNote>,
    #[serde(default)]
    pub provenance: Provenance,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProfileSource {
    pub kind: String,
    pub identifier: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProfileSubcommand {
    pub name: String,
    #[serde(default)]
    pub summary: String,
    #[serde(default)]
    pub interactive: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub interactive_reasons: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub non_interactive_alternatives: Vec<String>,
    #[serde(default)]
    pub confidence: ConfidenceLevel,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProfileOption {
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub short: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value_name: Option<String>,
    #[serde(default)]
    pub required: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    #[serde(default)]
    pub confidence: ConfidenceLevel,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProfilePositional {
    pub name: String,
    #[serde(default)]
    pub required: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    #[serde(default)]
    pub confidence: ConfidenceLevel,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProfileExample {
    pub command: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    #[serde(default)]
    pub confidence: ConfidenceLevel,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AuthRequirement {
    #[serde(default)]
    pub kind: String,
    #[serde(default)]
    pub summary: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EnvironmentRequirement {
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    #[serde(default)]
    pub required: bool,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OutputBehavior {
    #[serde(default)]
    pub stdout_style: String,
    #[serde(default)]
    pub stderr_usage: String,
    #[serde(default)]
    pub machine_friendly: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Workflow {
    pub name: String,
    #[serde(default)]
    pub steps: Vec<String>,
    #[serde(default)]
    pub confidence: ConfidenceLevel,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConfidenceNote {
    #[serde(default)]
    pub level: ConfidenceLevel,
    #[serde(default)]
    pub summary: String,
}

#[derive(Debug, Clone)]
pub struct ProfileQualityReport {
    pub ready_for_agent_docs: bool,
    pub score: u8,
    pub level: String,
    pub reasons: Vec<String>,
}

impl CliSurfaceProfile {
    pub fn quality_report(&self) -> ProfileQualityReport {
        let mut reasons = Vec::new();
        let mut score: i32 = 100;
        let generic_summary = self.summary.trim()
            == format!("{} command-line interface", self.command)
            || self.summary.trim().eq_ignore_ascii_case(&self.command)
            || self.summary.trim().len() < 24;
        if generic_summary {
            score -= 25;
            reasons.push(
                "Summary stayed generic, so generated startup docs may be less useful than a hand-written snippet."
                    .into(),
            );
        }
        if self.examples.is_empty() {
            score -= 15;
            reasons.push(
                "No usage examples were detected, so generated guidance may not show the best first command."
                    .into(),
            );
        }
        if self.subcommands.is_empty() && self.options.len() < 2 {
            score -= 25;
            reasons.push(
                "The inspected CLI surface is sparse; sxmc could not confidently extract subcommands or enough options."
                    .into(),
            );
        }
        if self.subcommand_profiles.is_empty() && self.subcommands.len() >= 3 {
            score -= 10;
            reasons.push(
                "Only top-level subcommands were captured; deeper nested help may still need a higher inspection depth."
                    .into(),
            );
        }
        if self.output_behavior.machine_friendly {
            score += 5;
        }
        if self.options.len() >= 8 {
            score += 5;
        }

        let rich_surface = !self.examples.is_empty()
            || !self.subcommand_profiles.is_empty()
            || self.subcommands.len() >= 3
            || self.options.len() >= 5;

        let score = score.clamp(0, 100) as u8;
        let level = if score >= 80 {
            "high"
        } else if score >= 55 {
            "medium"
        } else {
            "low"
        };

        ProfileQualityReport {
            ready_for_agent_docs: rich_surface
                && !(generic_summary && self.subcommands.is_empty() && self.options.len() < 3),
            score,
            level: level.into(),
            reasons,
        }
    }
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Provenance {
    #[serde(default)]
    pub generated_by: String,
    #[serde(default)]
    pub generator_version: String,
    #[serde(default)]
    pub source_kind: String,
    #[serde(default)]
    pub source_identifier: String,
    #[serde(default)]
    pub profile_schema: String,
    #[serde(default)]
    pub generation_depth: u32,
    #[serde(default)]
    pub generated_at: String,
}

#[derive(Debug, Copy, Clone, Default, Serialize, Deserialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ConfidenceLevel {
    High,
    #[default]
    Medium,
    Low,
}

#[derive(Debug, Copy, Clone, Eq, PartialEq, ValueEnum)]
pub enum AiClientProfile {
    ClaudeCode,
    Cursor,
    GeminiCli,
    GithubCopilot,
    ContinueDev,
    OpenCode,
    JetbrainsAiAssistant,
    Junie,
    Windsurf,
    OpenaiCodex,
    GenericStdioMcp,
    GenericHttpMcp,
}

#[derive(Debug, Copy, Clone, Eq, PartialEq, ValueEnum)]
pub enum ArtifactMode {
    Preview,
    WriteSidecar,
    Patch,
    Apply,
}

#[derive(Debug, Copy, Clone, Eq, PartialEq, ValueEnum)]
pub enum AiCoverage {
    Single,
    Full,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum ArtifactAudience {
    Shared,
    Portable,
    Client(AiClientProfile),
}

#[derive(Debug, Clone)]
pub struct GeneratedArtifact {
    pub label: String,
    pub target_path: PathBuf,
    pub content: String,
    pub apply_strategy: ApplyStrategy,
    pub audience: ArtifactAudience,
    pub sidecar_scope: String,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum ApplyStrategy {
    SidecarOnly,
    ManagedMarkdownBlock,
    JsonMcpConfig,
    TomlManagedBlock,
    DirectWrite,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum ConfigShape {
    JsonMcpServers,
    JsonMcp,
    TomlMcpServers,
}

#[derive(Debug, Clone, Copy)]
pub struct HostProfileSpec {
    pub client: AiClientProfile,
    pub label: &'static str,
    pub sidecar_scope: &'static str,
    pub native_doc_target: Option<&'static str>,
    pub native_config_target: Option<&'static str>,
    pub config_shape: Option<ConfigShape>,
    pub official_reference_url: &'static str,
}

pub const AI_HOST_SPECS: &[HostProfileSpec] = &[
    HostProfileSpec {
        client: AiClientProfile::ClaudeCode,
        label: "Claude Code",
        sidecar_scope: "claude-code",
        native_doc_target: Some("CLAUDE.md"),
        native_config_target: Some(".sxmc/ai/claude-code-mcp.json"),
        config_shape: Some(ConfigShape::JsonMcpServers),
        official_reference_url: "https://docs.anthropic.com/en/docs/claude-code/memory",
    },
    HostProfileSpec {
        client: AiClientProfile::Cursor,
        label: "Cursor",
        sidecar_scope: "cursor",
        native_doc_target: Some(".cursor/rules/sxmc-cli-ai.md"),
        native_config_target: Some(".cursor/mcp.json"),
        config_shape: Some(ConfigShape::JsonMcpServers),
        official_reference_url: "https://docs.cursor.com/context/rules-for-ai",
    },
    HostProfileSpec {
        client: AiClientProfile::GeminiCli,
        label: "Gemini CLI",
        sidecar_scope: "gemini-cli",
        native_doc_target: Some("GEMINI.md"),
        native_config_target: Some(".gemini/settings.json"),
        config_shape: Some(ConfigShape::JsonMcpServers),
        official_reference_url: "https://geminicli.com/docs/cli/gemini-md/",
    },
    HostProfileSpec {
        client: AiClientProfile::GithubCopilot,
        label: "GitHub Copilot",
        sidecar_scope: "github-copilot",
        native_doc_target: Some(".github/copilot-instructions.md"),
        native_config_target: None,
        config_shape: None,
        official_reference_url: "https://docs.github.com/en/copilot/tutorials/customization-library/custom-instructions/your-first-custom-instructions",
    },
    HostProfileSpec {
        client: AiClientProfile::ContinueDev,
        label: "Continue",
        sidecar_scope: "continue",
        native_doc_target: Some(".continue/rules/sxmc-cli-ai.md"),
        native_config_target: None,
        config_shape: None,
        official_reference_url: "https://docs.continue.dev/customize/rules",
    },
    HostProfileSpec {
        client: AiClientProfile::OpenCode,
        label: "OpenCode",
        sidecar_scope: "opencode",
        native_doc_target: Some("AGENTS.md"),
        native_config_target: Some("opencode.json"),
        config_shape: Some(ConfigShape::JsonMcp),
        official_reference_url: "https://opencode.ai/docs/rules",
    },
    HostProfileSpec {
        client: AiClientProfile::JetbrainsAiAssistant,
        label: "JetBrains AI Assistant",
        sidecar_scope: "jetbrains-ai-assistant",
        native_doc_target: Some(".aiassistant/rules/sxmc-cli-ai.md"),
        native_config_target: None,
        config_shape: None,
        official_reference_url: "https://www.jetbrains.com/help/ai-assistant/configure-project-rules.html",
    },
    HostProfileSpec {
        client: AiClientProfile::Junie,
        label: "Junie",
        sidecar_scope: "junie",
        native_doc_target: Some(".junie/guidelines.md"),
        native_config_target: None,
        config_shape: None,
        official_reference_url: "https://www.jetbrains.com/help/junie/customize-guidelines.html",
    },
    HostProfileSpec {
        client: AiClientProfile::Windsurf,
        label: "Windsurf",
        sidecar_scope: "windsurf",
        native_doc_target: Some(".windsurf/rules/sxmc-cli-ai.md"),
        native_config_target: None,
        config_shape: None,
        official_reference_url: "https://docs.windsurf.com/windsurf/cascade/memories",
    },
    HostProfileSpec {
        client: AiClientProfile::OpenaiCodex,
        label: "OpenAI/Codex",
        sidecar_scope: "openai-codex",
        native_doc_target: Some("AGENTS.md"),
        native_config_target: Some(".codex/mcp.toml"),
        config_shape: Some(ConfigShape::TomlMcpServers),
        official_reference_url: "https://developers.openai.com/codex/cli/",
    },
    HostProfileSpec {
        client: AiClientProfile::GenericStdioMcp,
        label: "Generic stdio MCP",
        sidecar_scope: "generic-stdio-mcp",
        native_doc_target: Some("AGENTS.md"),
        native_config_target: Some(".sxmc/ai/generic-stdio-mcp.json"),
        config_shape: Some(ConfigShape::JsonMcpServers),
        official_reference_url: "https://modelcontextprotocol.io/docs/learn/architecture",
    },
    HostProfileSpec {
        client: AiClientProfile::GenericHttpMcp,
        label: "Generic HTTP MCP",
        sidecar_scope: "generic-http-mcp",
        native_doc_target: Some("AGENTS.md"),
        native_config_target: Some(".sxmc/ai/generic-http-mcp.json"),
        config_shape: Some(ConfigShape::JsonMcpServers),
        official_reference_url: "https://modelcontextprotocol.io/docs/learn/architecture",
    },
];

#[derive(Debug, Clone)]
pub struct WriteOutcome {
    pub label: String,
    pub path: PathBuf,
    pub mode: ArtifactMode,
    pub status: WriteStatus,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum WriteStatus {
    Created,
    Updated,
    Skipped,
    Removed,
}

pub fn host_profile_spec(client: AiClientProfile) -> &'static HostProfileSpec {
    AI_HOST_SPECS
        .iter()
        .find(|spec| spec.client == client)
        .expect("missing host profile spec")
}