warmplane 0.23.0

Local control plane that keeps MCP sessions warm with compact capability/resource/prompt facades.
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
// Rust guideline compliant 2026-08-13

use clap::{Parser, Subcommand};

use crate::config::DEFAULT_CONFIG_PATH;

/// Top-level command line argument parser model for Warmplane CLI.
#[derive(Parser)]
#[command(
    name = "warmplane",
    version,
    about = "The local control plane that keeps MCP sessions warm"
)]
pub struct Cli {
    /// Subcommand to execute.
    #[command(subcommand)]
    pub command: Commands,
}

/// Warmplane CLI subcommands.
#[derive(Subcommand)]
pub enum Commands {
    /// Validate config file and exit (no daemon startup)
    ValidateConfig {
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Boot the background daemon
    Daemon {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional static authentication token protecting mutating daemon API endpoints
        #[arg(long)]
        auth_token: Option<String>,
    },
    /// Run as an MCP stdio server exposing the lightweight facade
    McpServer {
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional named server constellation (profile) to restrict exposed capabilities
        #[arg(long)]
        profile: Option<String>,
    },
    /// Run as a Streamable HTTP/SSE MCP server exposing the lightweight facade
    McpHttpServer {
        /// TCP port override (overrides config file and default of 9191)
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional named server constellation (profile) to restrict exposed capabilities
        #[arg(long)]
        profile: Option<String>,
        /// Bind address override (default: 127.0.0.1; use 0.0.0.0 for network access)
        #[arg(long)]
        bind: Option<String>,
    },
    /// Manage upstream MCP servers (add, remove, list, get, test)
    Server {
        #[command(subcommand)]
        command: ServerCommands,
    },
    /// Manage Warmplane configuration, aliases, policies, and imports
    Config {
        #[command(subcommand)]
        command: ConfigCommands,
    },
    /// Trigger a hot-reload of active upstream servers and policies from config file
    Reload {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// List compact capabilities from the v1 facade API
    ListCapabilities {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// Search capabilities using hybrid lexical and semantic search
    SearchCapabilities {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        query: String,
        #[arg(short, long, default_value = "8")]
        limit: usize,
        #[arg(short, long)]
        server: Vec<String>,
        #[arg(short, long)]
        tag: Vec<String>,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// Describe one capability with full on-demand schema from the v1 facade API
    DescribeCapability {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        id: String,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// Call one capability through the v1 facade API
    CallCapability {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        id: String,
        #[arg(short, long, default_value = "{}")]
        params: String,
        #[arg(long)]
        request_id: Option<String>,
        #[arg(long)]
        operation_id: Option<String>,
        #[arg(long)]
        work_item_id: Option<String>,
        #[arg(long)]
        actor_id: Option<String>,
        #[arg(long)]
        grant_id: Option<String>,
        #[arg(long)]
        idempotency_key: Option<String>,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
        /// Filter result payload with JSONPath expression (e.g. "$.items[*].name")
        #[arg(long)]
        jsonpath: Option<String>,
        /// Limit returned output lines
        #[arg(long)]
        limit_lines: Option<usize>,
        /// Truncate returned output byte size
        #[arg(long)]
        truncate_bytes: Option<usize>,
    },
    /// Execute a chained batch of tool capabilities
    BatchCallCapabilities {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// JSON array of step objects, or inline JSON string
        #[arg(short, long)]
        steps: Option<String>,
        /// Path to JSON file containing steps array
        #[arg(short = 'f', long)]
        file: Option<String>,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// List compact resources from the v1 facade API
    ListResources {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// Read one resource through the v1 facade API
    ReadResource {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        id: String,
        #[arg(long)]
        request_id: Option<String>,
        #[arg(long)]
        operation_id: Option<String>,
        #[arg(long)]
        work_item_id: Option<String>,
        #[arg(long)]
        actor_id: Option<String>,
        #[arg(long)]
        grant_id: Option<String>,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// List compact prompts from the v1 facade API
    ListPrompts {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// Get one prompt through the v1 facade API
    GetPrompt {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        id: String,
        #[arg(short, long, default_value = "{}")]
        arguments: String,
        #[arg(long)]
        request_id: Option<String>,
        #[arg(long)]
        operation_id: Option<String>,
        #[arg(long)]
        work_item_id: Option<String>,
        #[arg(long)]
        actor_id: Option<String>,
        #[arg(long)]
        grant_id: Option<String>,
        /// Optional named server constellation (profile)
        #[arg(long)]
        profile: Option<String>,
    },
    /// List catalog events from the v1 change feed API
    ListCatalogEvents {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        #[arg(short, long)]
        after: Option<String>,
    },
    /// Cancel an active in-flight operation by request ID
    CancelOperation {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        id: String,
    },
    /// Manage Human-in-the-Loop (HITL) capability approvals
    Approvals {
        #[command(subcommand)]
        command: ApprovalCommands,
    },
}

/// Upstream server management subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum ServerCommands {
    /// Add or configure an upstream MCP server
    Add(Box<ServerAddArgs>),
    /// Remove an upstream MCP server by identifier
    Remove {
        /// Server identifier
        name: String,
        /// Bypass confirmation prompt
        #[arg(short = 'y', long)]
        yes: bool,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// List all configured upstream MCP servers
    List {
        /// Output in JSON format
        #[arg(long)]
        json: bool,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Get details of a specific upstream MCP server
    Get {
        /// Server identifier
        name: String,
        /// Output in JSON format
        #[arg(long)]
        json: bool,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Test reachability and capability discovery with upstream server
    Test {
        /// Server identifier
        name: String,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Global Warmplane configuration management subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum ConfigCommands {
    /// Initialize a new Warmplane configuration file
    Init {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
        /// Overwrite existing configuration if present
        #[arg(short = 'f', long)]
        force: bool,
    },
    /// Show current merged configuration
    Show {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Import MCP server configurations from Claude Desktop, Cursor, or Zed
    Import {
        /// Automatically overwrite existing servers with same identifier
        #[arg(short = 'y', long)]
        yes: bool,
        /// Specific file path to import from (optional)
        #[arg(long)]
        from_file: Option<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Manage capability, resource, and prompt aliases
    Alias {
        #[command(subcommand)]
        command: AliasCommands,
    },
    /// Manage security access policies
    Policy {
        #[command(subcommand)]
        command: PolicyCommands,
    },
    /// Manage global fault tolerance and process supervision
    Resilience {
        #[command(subcommand)]
        command: ResilienceCommands,
    },
    /// Manage WORM audit trail and SIEM exporter settings
    Audit {
        #[command(subcommand)]
        command: AuditCommands,
    },
    /// Manage persistent runtime state configuration
    State {
        #[command(subcommand)]
        command: StateCommands,
    },
    /// Hot-reload daemon configuration and upstream servers from disk
    Reload {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Global resilience and supervisor subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum ResilienceCommands {
    /// Configure global resilience and circuit breaker settings
    Set {
        /// Consecutive failures required to trip circuit to Open
        #[arg(long)]
        failure_threshold: Option<u32>,
        /// Cooldown time in milliseconds in Open state before probe attempts
        #[arg(long)]
        cooldown_ms: Option<u64>,
        /// Consecutive successful probe calls in HalfOpen to reset circuit
        #[arg(long)]
        consecutive_successes: Option<u32>,
        /// Automatically restart crashed stdio child processes
        #[arg(long)]
        auto_restart: Option<bool>,
        /// Maximum restart attempts before giving up
        #[arg(long)]
        max_restarts: Option<u32>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Show current resilience and supervisor settings
    Show {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// WORM audit logging and SIEM exporter subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum AuditCommands {
    /// Configure WORM audit logging and SIEM export targets
    Set {
        /// Enable or disable audit logging
        #[arg(long)]
        enabled: Option<bool>,
        /// Append-only audit log file path on disk (e.g. warmplane_audit.jsonl)
        #[arg(long)]
        file_path: Option<String>,
        /// Queue buffer capacity
        #[arg(long)]
        buffer_capacity: Option<usize>,
        /// Flush interval in milliseconds
        #[arg(long)]
        flush_interval_ms: Option<u64>,
        /// Maximum batch size
        #[arg(long)]
        max_batch_size: Option<usize>,
        /// Add generic SIEM HTTP Webhook destination URL
        #[arg(long)]
        siem_webhook_url: Option<String>,
        /// SIEM HTTP Webhook Bearer authorization header
        #[arg(long)]
        siem_webhook_auth: Option<String>,
        /// Add Splunk HEC collector endpoint URL
        #[arg(long)]
        siem_splunk_url: Option<String>,
        /// Splunk HEC authentication token
        #[arg(long)]
        siem_splunk_token: Option<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Show current WORM audit logging and SIEM configuration
    Show {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Persistent runtime state management subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum StateCommands {
    /// Configure runtime state persistence settings
    Set {
        /// Enable or disable state persistence
        #[arg(long)]
        enabled: Option<bool>,
        /// State directory path
        #[arg(long)]
        dir: Option<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Show persistent runtime state configuration
    Show {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Alias management subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum AliasCommands {
    /// Set an alias
    Set {
        /// Alias type (tool, resource, prompt)
        kind: String,
        /// Alias name
        alias: String,
        /// Target canonical identifier or URI
        target: String,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Remove an alias
    Remove {
        /// Alias type (tool, resource, prompt)
        kind: String,
        /// Alias name
        alias: String,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// List all aliases
    List {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Policy management subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum PolicyCommands {
    /// Add capability patterns to allow list
    Allow {
        /// Capability pattern(s) (e.g. "github.*")
        patterns: Vec<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Add capability patterns to deny list
    Deny {
        /// Capability pattern(s) (e.g. "filesystem.write*")
        patterns: Vec<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Add capability patterns requiring human operator approval
    RequireApproval {
        /// Capability pattern(s) (e.g. "docker.run*", "db.write*")
        patterns: Vec<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Add sensitive keys to redact list
    Redact {
        /// Sensitive key names (e.g. "api_key", "password")
        keys: Vec<String>,
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Show current security policy rules
    Show {
        /// Path to Warmplane configuration file
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Human-in-the-Loop (HITL) approval subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum ApprovalCommands {
    /// List all pending approvals and recent history
    List {
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Get details of a specific approval ticket
    Get {
        /// Approval ticket identifier (e.g. appr-1723668200-1)
        id: String,
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Approve a pending capability execution
    Approve {
        /// Approval ticket identifier
        id: String,
        /// Operator identifier
        #[arg(short = 'o', long, default_value = "cli-operator")]
        operator: String,
        /// Optional modified JSON arguments to execute
        #[arg(short = 'm', long)]
        modified_args: Option<String>,
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
    /// Reject a pending capability execution
    Reject {
        /// Approval ticket identifier
        id: String,
        /// Operator identifier
        #[arg(short = 'o', long, default_value = "cli-operator")]
        operator: String,
        /// Reason explaining the rejection
        #[arg(short = 'r', long)]
        reason: Option<String>,
        #[arg(short = 'p', long)]
        port: Option<u16>,
        #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
        config: String,
    },
}

/// Arguments for `warmplane server add` command.
#[derive(clap::Args, Debug, Clone)]
pub struct ServerAddArgs {
    /// Server identifier (e.g. github, filesystem)
    pub name: Option<String>,
    /// Stdio executable command (e.g. npx, uvx, python)
    #[arg(long)]
    pub command: Option<String>,
    /// Command line arguments (repeat flag or space/comma separated)
    #[arg(short, long)]
    pub arg: Vec<String>,
    /// Environment variables in KEY=VALUE format
    #[arg(short, long)]
    pub env: Vec<String>,
    /// Remote HTTP/SSE URL endpoint
    #[arg(long)]
    pub url: Option<String>,
    /// Static Bearer token
    #[arg(long)]
    pub bearer_token: Option<String>,
    /// Environment variable containing Bearer token
    #[arg(long)]
    pub bearer_env: Option<String>,
    /// HTTP Basic auth username
    #[arg(long)]
    pub username: Option<String>,
    /// HTTP Basic auth password
    #[arg(long)]
    pub password: Option<String>,
    /// HTTP Basic auth password environment variable
    #[arg(long)]
    pub password_env: Option<String>,
    /// OAuth2 client ID
    #[arg(long)]
    pub client_id: Option<String>,
    /// OAuth2 authorization server URL
    #[arg(long)]
    pub auth_server: Option<String>,
    /// OAuth2 scopes (comma-separated)
    #[arg(long)]
    pub scopes: Option<String>,
    /// Consecutive failures required to trip circuit to Open
    #[arg(long)]
    pub failure_threshold: Option<u32>,
    /// Cooldown time in milliseconds in Open state before probe attempts
    #[arg(long)]
    pub cooldown_ms: Option<u64>,
    /// Consecutive successful probe calls in HalfOpen to reset circuit
    #[arg(long)]
    pub consecutive_successes: Option<u32>,
    /// Automatically restart crashed stdio child processes
    #[arg(long)]
    pub auto_restart: Option<bool>,
    /// Maximum restart attempts before giving up
    #[arg(long)]
    pub max_restarts: Option<u32>,
    /// Force interactive guided setup prompt
    #[arg(short, long)]
    pub interactive: bool,
    /// Path to Warmplane configuration file
    #[arg(short, long, default_value = DEFAULT_CONFIG_PATH)]
    pub config: String,
}