gen-orb-mcp 0.1.0

Generate MCP servers from CircleCI orb definitions
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
//! # gen-orb-mcp
//!
//! Generate MCP (Model Context Protocol) servers from CircleCI orb definitions.
//!
//! This tool enables AI coding assistants to understand and work with private
//! CircleCI orbs by generating MCP servers that expose orb commands, jobs,
//! and executors as resources.
//!
//! ## Usage
//!
//! ```bash
//! gen-orb-mcp generate --orb-path ./src/@orb.yml --output ./dist/
//! ```

pub mod generator;
pub mod parser;

use anyhow::Result;
use clap::{Parser, Subcommand};

use generator::CodeGenerator;
use parser::OrbParser;

/// Generate MCP servers from CircleCI orb definitions
#[derive(Debug, Parser)]
#[command(name = "gen-orb-mcp")]
#[command(author, version, about, long_about = None)]
pub struct Cli {
    #[command(subcommand)]
    command: Commands,
}

#[derive(Debug, Subcommand)]
enum Commands {
    /// Generate an MCP server from an orb definition
    Generate {
        /// Path to the orb YAML file (e.g., src/@orb.yml)
        #[arg(short = 'p', long)]
        orb_path: std::path::PathBuf,

        /// Output directory for generated server
        #[arg(short = 'o', long, default_value = "./dist")]
        output: std::path::PathBuf,

        /// Output format
        #[arg(short, long, value_enum, default_value = "source")]
        format: OutputFormat,

        /// Name for the generated orb server (defaults to filename)
        #[arg(short, long)]
        name: Option<String>,

        /// Version for the generated MCP server crate (e.g., "1.0.0")
        ///
        /// Required when regenerating an existing output directory.
        /// For CI workflows, this should match the orb release version.
        #[arg(short = 'V', long)]
        version: Option<String>,

        /// Overwrite existing files without confirmation
        ///
        /// Required for non-interactive CI environments when output exists.
        #[arg(long)]
        force: bool,
    },
    /// Validate an orb definition without generating
    Validate {
        /// Path to the orb YAML file
        #[arg(short = 'p', long)]
        orb_path: std::path::PathBuf,
    },
}

/// Output format for generated MCP server
#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
pub enum OutputFormat {
    /// Compile to native binary (Linux x86_64)
    Binary,
    /// Generate Rust source code
    Source,
}

/// Default version for fresh generation when no version is specified.
const DEFAULT_VERSION: &str = "0.1.0";

impl Cli {
    /// Execute the CLI command
    pub fn run(&self) -> Result<()> {
        match &self.command {
            Commands::Generate {
                orb_path,
                output,
                format,
                name,
                version,
                force,
            } => {
                tracing::info!(?orb_path, ?output, ?format, "Generating MCP server");

                // Parse the orb definition
                let orb = OrbParser::parse(orb_path).map_err(|e| anyhow::anyhow!("{}", e))?;
                tracing::info!(
                    commands = orb.commands.len(),
                    jobs = orb.jobs.len(),
                    executors = orb.executors.len(),
                    "Parsed orb definition"
                );

                // Derive orb name from path if not specified
                let orb_name = name.clone().unwrap_or_else(|| derive_orb_name(orb_path));

                // Resolve version based on output state
                let resolved_version = resolve_version(output, version.as_deref(), *force)?;
                tracing::info!(version = %resolved_version, "Using version");

                // Create generator and generate code
                let generator = CodeGenerator::new().map_err(|e| anyhow::anyhow!("{}", e))?;
                let server = generator
                    .generate(&orb, &orb_name, &resolved_version)
                    .map_err(|e| anyhow::anyhow!("{}", e))?;

                // Write output
                match format {
                    OutputFormat::Source => {
                        server
                            .write_to(output)
                            .map_err(|e| anyhow::anyhow!("{}", e))?;
                        println!("Generated MCP server source code:");
                        println!("  Output: {}", output.display());
                        println!("  Crate: {}", server.crate_name);
                        println!("  Version: {}", resolved_version);
                        println!("  Commands: {}", orb.commands.len());
                        println!("  Jobs: {}", orb.jobs.len());
                        println!("  Executors: {}", orb.executors.len());
                        println!();
                        println!("To build: cd {} && cargo build --release", output.display());
                    }
                    OutputFormat::Binary => {
                        // Write source first
                        server
                            .write_to(output)
                            .map_err(|e| anyhow::anyhow!("{}", e))?;

                        // Attempt to compile
                        println!("Compiling MCP server...");
                        let status = std::process::Command::new("cargo")
                            .args(["build", "--release"])
                            .current_dir(output)
                            .status();

                        match status {
                            Ok(s) if s.success() => {
                                let binary_path =
                                    output.join("target/release").join(&server.crate_name);
                                println!("Successfully compiled MCP server:");
                                println!("  Binary: {}", binary_path.display());
                                println!("  Version: {}", resolved_version);
                            }
                            Ok(_) => {
                                anyhow::bail!(
                                    "Compilation failed. Source code is available at: {}",
                                    output.display()
                                );
                            }
                            Err(e) => {
                                anyhow::bail!(
                                    "Failed to run cargo: {}. Source code is available at: {}",
                                    e,
                                    output.display()
                                );
                            }
                        }
                    }
                }

                Ok(())
            }
            Commands::Validate { orb_path } => {
                tracing::info!(?orb_path, "Validating orb definition");

                // Parse and validate the orb definition
                let orb = OrbParser::parse(orb_path).map_err(|e| anyhow::anyhow!("{}", e))?;

                println!("Orb validation successful!");
                println!("  Version: {}", orb.version);
                if let Some(desc) = &orb.description {
                    println!("  Description: {}", desc);
                }
                println!("  Commands: {}", orb.commands.len());
                for name in orb.commands.keys() {
                    println!("    - {}", name);
                }
                println!("  Jobs: {}", orb.jobs.len());
                for name in orb.jobs.keys() {
                    println!("    - {}", name);
                }
                println!("  Executors: {}", orb.executors.len());
                for name in orb.executors.keys() {
                    println!("    - {}", name);
                }
                Ok(())
            }
        }
    }
}

/// Derive orb name from the orb path.
///
/// For unpacked orbs (`@orb.yml`), uses the project directory name.
/// Handles the common `project/src/@orb.yml` structure by skipping the `src` directory.
/// For packed orbs, uses the file stem (filename without extension).
fn derive_orb_name(path: &std::path::Path) -> String {
    let filename = path.file_name().and_then(|s| s.to_str()).unwrap_or("orb");

    if filename == "@orb.yml" {
        // Get parent directory
        let parent = path.parent();
        let parent_name = parent.and_then(|p| p.file_name()).and_then(|s| s.to_str());

        // If parent is "src", go up one more level to get project name
        if parent_name == Some("src") {
            parent
                .and_then(|p| p.parent())
                .and_then(|p| p.file_name())
                .and_then(|s| s.to_str())
                .unwrap_or("orb")
                .to_string()
        } else {
            parent_name.unwrap_or("orb").to_string()
        }
    } else {
        // Use filename without extension
        path.file_stem()
            .and_then(|s| s.to_str())
            .unwrap_or("orb")
            .to_string()
    }
}

/// Resolve the version to use for the generated MCP server.
///
/// # Version Resolution Rules
///
/// 1. If `--version` is provided, use it
/// 2. If output directory exists with Cargo.toml and no `--version`:
///    - Error: must specify version to regenerate
/// 3. If fresh generation and no `--version`: use DEFAULT_VERSION
///
/// The `--force` flag is required when overwriting existing output.
fn resolve_version(output: &std::path::Path, version: Option<&str>, force: bool) -> Result<String> {
    let cargo_toml = output.join("Cargo.toml");
    let output_exists = cargo_toml.exists();

    match (version, output_exists) {
        // Explicit version provided - use it
        (Some(v), false) => {
            tracing::debug!("Using provided version for fresh generation");
            Ok(v.to_string())
        }
        (Some(v), true) => {
            if !force {
                anyhow::bail!(
                    "Output directory '{}' already exists. Use --force to overwrite.",
                    output.display()
                );
            }
            tracing::debug!("Using provided version, overwriting existing output");
            Ok(v.to_string())
        }

        // No version provided
        (None, false) => {
            tracing::debug!("Fresh generation with default version");
            Ok(DEFAULT_VERSION.to_string())
        }
        (None, true) => {
            anyhow::bail!(
                "Output directory '{}' already exists.\n\
                 To regenerate, you must specify the version explicitly:\n\n\
                 \x20   gen-orb-mcp generate --orb-path <PATH> --output {} --version <VERSION> --force\n\n\
                 For CI release workflows, use the orb release version (e.g., --version 1.6.0).",
                output.display(),
                output.display()
            );
        }
    }
}

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

    #[test]
    fn test_cli_parse_generate() {
        let cli = Cli::try_parse_from([
            "gen-orb-mcp",
            "generate",
            "--orb-path",
            "test.yml",
            "--output",
            "./out",
        ]);
        assert!(cli.is_ok());
    }

    #[test]
    fn test_cli_parse_generate_with_version() {
        let cli = Cli::try_parse_from([
            "gen-orb-mcp",
            "generate",
            "--orb-path",
            "test.yml",
            "--output",
            "./out",
            "--version",
            "1.2.3",
        ]);
        assert!(cli.is_ok());
    }

    #[test]
    fn test_cli_parse_generate_with_force() {
        let cli = Cli::try_parse_from([
            "gen-orb-mcp",
            "generate",
            "--orb-path",
            "test.yml",
            "--output",
            "./out",
            "--version",
            "1.2.3",
            "--force",
        ]);
        assert!(cli.is_ok());
    }

    #[test]
    fn test_cli_parse_validate() {
        let cli = Cli::try_parse_from(["gen-orb-mcp", "validate", "--orb-path", "test.yml"]);
        assert!(cli.is_ok());
    }

    #[test]
    fn test_derive_orb_name_from_orb_yml() {
        use std::path::Path;
        // Standard orb structure: project/src/@orb.yml -> "project"
        let path = Path::new("/path/to/my-toolkit/src/@orb.yml");
        assert_eq!(derive_orb_name(path), "my-toolkit");

        // Non-standard structure without src: my-orb/@orb.yml -> "my-orb"
        let path = Path::new("my-orb/@orb.yml");
        assert_eq!(derive_orb_name(path), "my-orb");

        // Edge case: src/@orb.yml at root -> "orb" (no grandparent, falls back to default)
        let path = Path::new("src/@orb.yml");
        assert_eq!(derive_orb_name(path), "orb");
    }

    #[test]
    fn test_derive_orb_name_from_packed() {
        use std::path::Path;
        let path = Path::new("/path/to/my-toolkit.yml");
        assert_eq!(derive_orb_name(path), "my-toolkit");

        let path = Path::new("orb.yml");
        assert_eq!(derive_orb_name(path), "orb");
    }

    #[test]
    fn test_resolve_version_fresh_with_explicit() {
        let temp_dir = TempDir::new().unwrap();
        let result = resolve_version(temp_dir.path(), Some("2.0.0"), false);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), "2.0.0");
    }

    #[test]
    fn test_resolve_version_fresh_with_default() {
        let temp_dir = TempDir::new().unwrap();
        let result = resolve_version(temp_dir.path(), None, false);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), DEFAULT_VERSION);
    }

    #[test]
    fn test_resolve_version_existing_without_version_fails() {
        let temp_dir = TempDir::new().unwrap();
        // Create a Cargo.toml to simulate existing output
        std::fs::write(
            temp_dir.path().join("Cargo.toml"),
            "[package]\nname = \"test\"",
        )
        .unwrap();

        let result = resolve_version(temp_dir.path(), None, false);
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("already exists"));
        assert!(err.contains("--version"));
    }

    #[test]
    fn test_resolve_version_existing_with_version_no_force_fails() {
        let temp_dir = TempDir::new().unwrap();
        std::fs::write(
            temp_dir.path().join("Cargo.toml"),
            "[package]\nname = \"test\"",
        )
        .unwrap();

        let result = resolve_version(temp_dir.path(), Some("1.5.0"), false);
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("--force"));
    }

    #[test]
    fn test_resolve_version_existing_with_version_and_force_succeeds() {
        let temp_dir = TempDir::new().unwrap();
        std::fs::write(
            temp_dir.path().join("Cargo.toml"),
            "[package]\nname = \"test\"",
        )
        .unwrap();

        let result = resolve_version(temp_dir.path(), Some("1.5.0"), true);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), "1.5.0");
    }
}