redisctl-mcp 0.8.3

MCP (Model Context Protocol) server for Redis Cloud and Enterprise
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
//! Cluster, license, node, maintenance, and certificate tools

use redis_enterprise::cluster::ClusterHandler;
use redis_enterprise::license::{LicenseHandler, LicenseUpdateRequest};
use redis_enterprise::nodes::NodeHandler;
use redis_enterprise::stats::{StatsHandler, StatsQuery};
use serde_json::Value;
use tower_mcp::{CallToolResult, ResultExt};

use crate::tools::macros::{enterprise_tool, mcp_module};

mcp_module! {
    get_cluster => "get_cluster",
    get_cluster_stats => "get_cluster_stats",
    update_cluster => "update_enterprise_cluster",
    get_cluster_policy => "get_enterprise_cluster_policy",
    update_cluster_policy => "update_enterprise_cluster_policy",
    enable_maintenance_mode => "enable_enterprise_maintenance_mode",
    disable_maintenance_mode => "disable_enterprise_maintenance_mode",
    get_cluster_certificates => "get_enterprise_cluster_certificates",
    rotate_cluster_certificates => "rotate_enterprise_cluster_certificates",
    update_cluster_certificates => "update_enterprise_cluster_certificates",
    get_license => "get_license",
    get_license_usage => "get_license_usage",
    update_license => "update_enterprise_license",
    validate_license => "validate_enterprise_license",
    list_nodes => "list_nodes",
    get_node => "get_node",
    get_node_stats => "get_node_stats",
    enable_node_maintenance => "enable_enterprise_node_maintenance",
    disable_node_maintenance => "disable_enterprise_node_maintenance",
    rebalance_node => "rebalance_enterprise_node",
    drain_node => "drain_enterprise_node",
    update_enterprise_node => "update_enterprise_node",
    remove_enterprise_node => "remove_enterprise_node",
    get_enterprise_cluster_services => "get_enterprise_cluster_services",
}

// ============================================================================
// Cluster tools
// ============================================================================

enterprise_tool!(read_only, get_cluster, "get_cluster",
    "Get cluster information including name, version, and configuration",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let cluster = handler
            .info()
            .await
            .tool_context("Failed to get cluster info")?;

        CallToolResult::from_serialize(&cluster)
    }
);

enterprise_tool!(read_only, get_cluster_stats, "get_cluster_stats",
    "Get cluster-level statistics. Optionally specify interval and time range \
     for historical data.",
    {
        /// Time interval for aggregation: "1sec", "10sec", "5min", "15min", "1hour", "12hour", "1week"
        #[serde(default)]
        pub interval: Option<String>,
        /// Start time for historical query (ISO 8601 format, e.g., "2024-01-15T10:00:00Z")
        #[serde(default)]
        pub start_time: Option<String>,
        /// End time for historical query (ISO 8601 format)
        #[serde(default)]
        pub end_time: Option<String>,
    } => |client, input| {
        let handler = StatsHandler::new(client);

        if input.interval.is_some()
            || input.start_time.is_some()
            || input.end_time.is_some()
        {
            let query = StatsQuery {
                interval: input.interval,
                stime: input.start_time,
                etime: input.end_time,
                metrics: None,
            };
            let stats = handler
                .cluster(Some(query))
                .await
                .tool_context("Failed to get cluster stats")?;
            CallToolResult::from_serialize(&stats)
        } else {
            let stats = handler
                .cluster_last()
                .await
                .tool_context("Failed to get cluster stats")?;
            CallToolResult::from_serialize(&stats)
        }
    }
);

enterprise_tool!(write, update_cluster, "update_enterprise_cluster",
    "Update cluster configuration settings. Pass fields to update as JSON.",
    {
        /// JSON object with cluster settings to update (e.g., {"name": "my-cluster", "email_alerts": true})
        pub updates: Value,
    } => |client, input| {
        let handler = ClusterHandler::new(client);
        let result = handler
            .update(input.updates)
            .await
            .tool_context("Failed to update cluster")?;

        CallToolResult::from_serialize(&result)
    }
);

enterprise_tool!(read_only, get_cluster_policy, "get_enterprise_cluster_policy",
    "Get cluster policy settings including default shards placement, \
     rack awareness, and default Redis version.",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let policy = handler
            .policy()
            .await
            .tool_context("Failed to get cluster policy")?;

        CallToolResult::from_serialize(&policy)
    }
);

enterprise_tool!(write, update_cluster_policy, "update_enterprise_cluster_policy",
    "Update cluster policy settings. Pass fields to update as JSON.",
    {
        /// JSON object with policy settings to update
        /// (e.g., {"default_shards_placement": "sparse", "rack_aware": true, "default_provisioned_redis_version": "7.2"})
        pub policy: Value,
    } => |client, input| {
        let handler = ClusterHandler::new(client);
        let result = handler
            .policy_update(input.policy)
            .await
            .tool_context("Failed to update cluster policy")?;

        CallToolResult::from_serialize(&result)
    }
);

// ============================================================================
// Maintenance Mode Operations
// ============================================================================

enterprise_tool!(write, enable_maintenance_mode, "enable_enterprise_maintenance_mode",
    "Enable maintenance mode. Configuration changes will be blocked \
     until maintenance mode is disabled.",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let result = handler
            .update(serde_json::json!({"block_cluster_changes": true}))
            .await
            .tool_context("Failed to enable maintenance mode")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Maintenance mode enabled",
            "result": result
        }))
    }
);

enterprise_tool!(write, disable_maintenance_mode, "disable_enterprise_maintenance_mode",
    "Disable maintenance mode and re-enable configuration changes.",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let result = handler
            .update(serde_json::json!({"block_cluster_changes": false}))
            .await
            .tool_context("Failed to disable maintenance mode")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Maintenance mode disabled",
            "result": result
        }))
    }
);

// ============================================================================
// Certificate Operations
// ============================================================================

enterprise_tool!(read_only, get_cluster_certificates, "get_enterprise_cluster_certificates",
    "Get all configured certificates (proxy, syncer, API).",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let certificates = handler
            .certificates()
            .await
            .tool_context("Failed to get certificates")?;

        CallToolResult::from_serialize(&certificates)
    }
);

enterprise_tool!(write, rotate_cluster_certificates, "rotate_enterprise_cluster_certificates",
    "Rotate all certificates, generating new ones to replace existing.",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let result = handler
            .certificates_rotate()
            .await
            .tool_context("Failed to rotate certificates")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Certificate rotation initiated",
            "result": result
        }))
    }
);

enterprise_tool!(write, update_cluster_certificates, "update_enterprise_cluster_certificates",
    "Update a specific certificate. Provide the certificate name (proxy, syncer, api), \
     PEM-encoded certificate, and PEM-encoded private key.",
    {
        /// Certificate name (e.g., "proxy", "syncer", "api")
        pub name: String,
        /// PEM-encoded certificate content
        pub certificate: String,
        /// PEM-encoded private key content
        pub key: String,
    } => |client, input| {
        let handler = ClusterHandler::new(client);
        let body = serde_json::json!({
            "name": &input.name,
            "certificate": input.certificate,
            "key": input.key
        });
        let result = handler
            .update_cert(body)
            .await
            .tool_context("Failed to update certificate")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Certificate updated successfully",
            "name": input.name,
            "result": result
        }))
    }
);

// ============================================================================
// License tools
// ============================================================================

enterprise_tool!(read_only, get_license, "get_license",
    "Get license information including type, expiration, and enabled features",
    {} => |client, _input| {
        let handler = LicenseHandler::new(client);
        let license = handler.get().await.tool_context("Failed to get license")?;

        CallToolResult::from_serialize(&license)
    }
);

enterprise_tool!(read_only, get_license_usage, "get_license_usage",
    "Get license utilization statistics including shards, nodes, and RAM usage against limits",
    {} => |client, _input| {
        let handler = LicenseHandler::new(client);
        let usage = handler
            .usage()
            .await
            .tool_context("Failed to get license usage")?;

        CallToolResult::from_serialize(&usage)
    }
);

enterprise_tool!(write, update_license, "update_enterprise_license",
    "Apply a new license key to the cluster.",
    {
        /// The license key string to install
        pub license_key: String,
    } => |client, input| {
        let handler = LicenseHandler::new(client);
        let request = LicenseUpdateRequest {
            license: input.license_key,
        };
        let license = handler
            .update(request)
            .await
            .tool_context("Failed to update license")?;

        CallToolResult::from_serialize(&license)
    }
);

enterprise_tool!(read_only, validate_license, "validate_enterprise_license",
    "Validate a license key without applying it (dry-run).",
    {
        /// The license key string to validate
        pub license_key: String,
    } => |client, input| {
        let handler = LicenseHandler::new(client);
        let license = handler
            .validate(&input.license_key)
            .await
            .tool_context("License validation failed")?;

        CallToolResult::from_serialize(&license)
    }
);

// ============================================================================
// Node tools
// ============================================================================

enterprise_tool!(read_only, list_nodes, "list_nodes",
    "List all nodes.",
    {} => |client, _input| {
        let handler = NodeHandler::new(client);
        let nodes = handler.list().await.tool_context("Failed to list nodes")?;

        crate::tools::wrap_list("nodes", &nodes)
    }
);

enterprise_tool!(read_only, get_node, "get_node",
    "Get detailed information about a specific node by UID.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let node = handler
            .get(input.uid)
            .await
            .tool_context("Failed to get node")?;

        CallToolResult::from_serialize(&node)
    }
);

enterprise_tool!(read_only, get_node_stats, "get_node_stats",
    "Get statistics for a specific node. Optionally specify interval and time range \
     for historical data.",
    {
        /// Node UID
        pub uid: u32,
        /// Time interval for aggregation: "1sec", "10sec", "5min", "15min", "1hour", "12hour", "1week"
        #[serde(default)]
        pub interval: Option<String>,
        /// Start time for historical query (ISO 8601 format, e.g., "2024-01-15T10:00:00Z")
        #[serde(default)]
        pub start_time: Option<String>,
        /// End time for historical query (ISO 8601 format)
        #[serde(default)]
        pub end_time: Option<String>,
    } => |client, input| {
        let handler = StatsHandler::new(client);

        if input.interval.is_some()
            || input.start_time.is_some()
            || input.end_time.is_some()
        {
            let query = StatsQuery {
                interval: input.interval,
                stime: input.start_time,
                etime: input.end_time,
                metrics: None,
            };
            let stats = handler
                .node(input.uid, Some(query))
                .await
                .tool_context("Failed to get node stats")?;
            CallToolResult::from_serialize(&stats)
        } else {
            let stats = handler
                .node_last(input.uid)
                .await
                .tool_context("Failed to get node stats")?;
            CallToolResult::from_serialize(&stats)
        }
    }
);

// ============================================================================
// Node Action Operations
// ============================================================================

enterprise_tool!(write, enable_node_maintenance, "enable_enterprise_node_maintenance",
    "Enable maintenance mode on a specific node. Shards will be migrated off first.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let result = handler
            .execute_action(input.uid, "maintenance_on")
            .await
            .tool_context("Failed to enable node maintenance")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Node maintenance mode enabled",
            "node_uid": input.uid,
            "action_uid": result.action_uid,
            "description": result.description
        }))
    }
);

enterprise_tool!(write, disable_node_maintenance, "disable_enterprise_node_maintenance",
    "Disable maintenance mode on a specific node. The node will accept shards again.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let result = handler
            .execute_action(input.uid, "maintenance_off")
            .await
            .tool_context("Failed to disable node maintenance")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Node maintenance mode disabled",
            "node_uid": input.uid,
            "action_uid": result.action_uid,
            "description": result.description
        }))
    }
);

enterprise_tool!(write, rebalance_node, "rebalance_enterprise_node",
    "Rebalance shards on a specific node for optimal distribution.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let result = handler
            .execute_action(input.uid, "rebalance")
            .await
            .tool_context("Failed to rebalance node")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Node rebalance initiated",
            "node_uid": input.uid,
            "action_uid": result.action_uid,
            "description": result.description
        }))
    }
);

enterprise_tool!(write, drain_node, "drain_enterprise_node",
    "Drain all shards from a specific node, migrating them to other nodes.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let result = handler
            .execute_action(input.uid, "drain")
            .await
            .tool_context("Failed to drain node")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Node drain initiated",
            "node_uid": input.uid,
            "action_uid": result.action_uid,
            "description": result.description
        }))
    }
);

// ============================================================================
// Node Update/Remove Operations
// ============================================================================

enterprise_tool!(write, update_enterprise_node, "update_enterprise_node",
    "Update a node's configuration. Pass fields to update as JSON.",
    {
        /// Node UID
        pub uid: u32,
        /// JSON object with node settings to update
        pub updates: Value,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        let node = handler
            .update(input.uid, input.updates)
            .await
            .tool_context("Failed to update node")?;

        CallToolResult::from_serialize(&node)
    }
);

enterprise_tool!(destructive, remove_enterprise_node, "remove_enterprise_node",
    "DANGEROUS: Remove a node. All shards must be drained first.",
    {
        /// Node UID
        pub uid: u32,
    } => |client, input| {
        let handler = NodeHandler::new(client);
        handler
            .remove(input.uid)
            .await
            .tool_context("Failed to remove node")?;

        CallToolResult::from_serialize(&serde_json::json!({
            "message": "Node removed successfully",
            "uid": input.uid
        }))
    }
);

// ============================================================================
// Cluster Services
// ============================================================================

enterprise_tool!(read_only, get_enterprise_cluster_services, "get_enterprise_cluster_services",
    "Get the list of cluster services.",
    {} => |client, _input| {
        let handler = ClusterHandler::new(client);
        let services = handler
            .services_configuration()
            .await
            .tool_context("Failed to get cluster services")?;

        CallToolResult::from_serialize(&services)
    }
);