redisctl-mcp 0.2.0

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
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
//! Redis Cloud API tools

use std::sync::Arc;

use redis_cloud::flexible::{DatabaseHandler, SubscriptionHandler};
use redis_cloud::{AccountHandler, AclHandler, TaskHandler, UserHandler};
use schemars::JsonSchema;
use serde::Deserialize;
use tower_mcp::{CallToolResult, Tool, ToolBuilder, ToolError};

use crate::state::AppState;

/// Input for listing subscriptions
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListSubscriptionsInput {}

/// Build the list_subscriptions tool
pub fn list_subscriptions(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_subscriptions")
        .description("List all Redis Cloud subscriptions accessible with the current credentials. Returns JSON with subscription details.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListSubscriptionsInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = SubscriptionHandler::new(client);
            let account_subs = handler
                .get_all_subscriptions()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list subscriptions: {}", e)))?;

            let output = serde_json::to_string_pretty(&account_subs)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting a specific subscription
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetSubscriptionInput {
    /// Subscription ID
    pub subscription_id: i32,
}

/// Build the get_subscription tool
pub fn get_subscription(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_subscription")
        .description("Get detailed information about a specific Redis Cloud subscription. Returns JSON with full subscription details.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetSubscriptionInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = SubscriptionHandler::new(client);
            let subscription = handler
                .get_subscription_by_id(input.subscription_id)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get subscription: {}", e)))?;

            let output = serde_json::to_string_pretty(&subscription)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for listing databases
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListDatabasesInput {
    /// Subscription ID
    pub subscription_id: i32,
}

/// Build the list_databases tool
pub fn list_databases(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_databases")
        .description(
            "List all databases in a Redis Cloud subscription. Returns JSON with database details.",
        )
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: ListDatabasesInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = DatabaseHandler::new(client);
            let databases = handler
                .get_subscription_databases(input.subscription_id, None, None)
                .await
                .map_err(|e| ToolError::new(format!("Failed to list databases: {}", e)))?;

            let output = serde_json::to_string_pretty(&databases)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting a specific database
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetDatabaseInput {
    /// Subscription ID
    pub subscription_id: i32,
    /// Database ID
    pub database_id: i32,
}

/// Build the get_database tool
pub fn get_database(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_database")
        .description("Get detailed information about a specific Redis Cloud database. Returns JSON with full database configuration.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetDatabaseInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = DatabaseHandler::new(client);
            let database = handler
                .get_subscription_database_by_id(input.subscription_id, input.database_id)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get database: {}", e)))?;

            let output = serde_json::to_string_pretty(&database)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

// ============================================================================
// Account tools
// ============================================================================

/// Input for getting current account
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetAccountInput {}

/// Build the get_account tool
pub fn get_account(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_account")
        .description("Get information about the current Redis Cloud account including name, ID, and settings.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: GetAccountInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AccountHandler::new(client);
            let account = handler
                .get_current_account()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get account: {}", e)))?;

            let output = serde_json::to_string_pretty(&account)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting supported regions
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetRegionsInput {
    /// Optional cloud provider filter (e.g., "AWS", "GCP", "Azure")
    #[serde(default)]
    pub provider: Option<String>,
}

/// Build the get_regions tool
pub fn get_regions(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_regions")
        .description(
            "Get supported cloud regions for Redis Cloud. Optionally filter by provider (AWS, GCP, Azure).",
        )
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetRegionsInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AccountHandler::new(client);
            let regions = handler
                .get_supported_regions(input.provider)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get regions: {}", e)))?;

            let output = serde_json::to_string_pretty(&regions)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting database modules
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetModulesInput {}

/// Build the get_modules tool
pub fn get_modules(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_modules")
        .description(
            "Get supported Redis database modules (e.g., Search, JSON, TimeSeries, Bloom).",
        )
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: GetModulesInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AccountHandler::new(client);
            let modules = handler
                .get_supported_database_modules()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get modules: {}", e)))?;

            let output = serde_json::to_string_pretty(&modules)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

// ============================================================================
// Task tools
// ============================================================================

/// Input for listing tasks
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListTasksInput {}

/// Build the list_tasks tool
pub fn list_tasks(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_tasks")
        .description("List all async tasks in the Redis Cloud account. Tasks track long-running operations like database creation.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListTasksInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = TaskHandler::new(client);
            let tasks = handler
                .get_all_tasks()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list tasks: {}", e)))?;

            let output = serde_json::to_string_pretty(&tasks)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting a specific task
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetTaskInput {
    /// Task ID
    pub task_id: String,
}

/// Build the get_task tool
pub fn get_task(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_task")
        .description("Get status and details of a specific async task by ID.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetTaskInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = TaskHandler::new(client);
            let task = handler
                .get_task_by_id(input.task_id)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get task: {}", e)))?;

            let output = serde_json::to_string_pretty(&task)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

// ============================================================================
// Account Users tools
// ============================================================================

/// Input for listing account users
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListAccountUsersInput {}

/// Build the list_account_users tool
pub fn list_account_users(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_account_users")
        .description(
            "List all users in the Redis Cloud account (team members with console access).",
        )
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListAccountUsersInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = UserHandler::new(client);
            let users = handler
                .get_all_users()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list users: {}", e)))?;

            let output = serde_json::to_string_pretty(&users)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

// ============================================================================
// ACL tools (database-level access control)
// ============================================================================

/// Input for listing ACL users
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListAclUsersInput {}

/// Build the list_acl_users tool
pub fn list_acl_users(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_acl_users")
        .description("List all ACL users (database-level Redis users for authentication).")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListAclUsersInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AclHandler::new(client);
            let users = handler
                .get_all_acl_users()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list ACL users: {}", e)))?;

            let output = serde_json::to_string_pretty(&users)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for listing ACL roles
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListAclRolesInput {}

/// Build the list_acl_roles tool
pub fn list_acl_roles(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_acl_roles")
        .description("List all ACL roles (permission templates for database access).")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListAclRolesInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AclHandler::new(client);
            let roles = handler
                .get_roles()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list ACL roles: {}", e)))?;

            let output = serde_json::to_string_pretty(&roles)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for listing Redis rules
#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListRedisRulesInput {}

/// Build the list_redis_rules tool
pub fn list_redis_rules(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("list_redis_rules")
        .description("List all Redis ACL rules (command permissions for Redis users).")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, _input: ListRedisRulesInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = AclHandler::new(client);
            let rules = handler
                .get_all_redis_rules()
                .await
                .map_err(|e| ToolError::new(format!("Failed to list Redis rules: {}", e)))?;

            let output = serde_json::to_string_pretty(&rules)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

// ============================================================================
// Database operations tools
// ============================================================================

/// Input for getting database backup status
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetBackupStatusInput {
    /// Subscription ID
    pub subscription_id: i32,
    /// Database ID
    pub database_id: i32,
    /// Optional region name for Active-Active databases
    #[serde(default)]
    pub region_name: Option<String>,
}

/// Build the get_backup_status tool
pub fn get_backup_status(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_backup_status")
        .description("Get backup status and history for a Redis Cloud database.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetBackupStatusInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = DatabaseHandler::new(client);
            let status = handler
                .get_database_backup_status(
                    input.subscription_id,
                    input.database_id,
                    input.region_name,
                )
                .await
                .map_err(|e| ToolError::new(format!("Failed to get backup status: {}", e)))?;

            let output = serde_json::to_string_pretty(&status)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting slow log
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetSlowLogInput {
    /// Subscription ID
    pub subscription_id: i32,
    /// Database ID
    pub database_id: i32,
    /// Optional region name for Active-Active databases
    #[serde(default)]
    pub region_name: Option<String>,
}

/// Build the get_slow_log tool
pub fn get_slow_log(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_slow_log")
        .description(
            "Get slow log entries for a Redis Cloud database. Shows slow queries for debugging.",
        )
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetSlowLogInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = DatabaseHandler::new(client);
            let log = handler
                .get_slow_log(input.subscription_id, input.database_id, input.region_name)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get slow log: {}", e)))?;

            let output = serde_json::to_string_pretty(&log)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}

/// Input for getting database tags
#[derive(Debug, Deserialize, JsonSchema)]
pub struct GetTagsInput {
    /// Subscription ID
    pub subscription_id: i32,
    /// Database ID
    pub database_id: i32,
}

/// Build the get_tags tool
pub fn get_tags(state: Arc<AppState>) -> Tool {
    ToolBuilder::new("get_database_tags")
        .description("Get tags attached to a Redis Cloud database.")
        .read_only()
        .idempotent()
        .handler_with_state(state, |state, input: GetTagsInput| async move {
            let client = state
                .cloud_client()
                .await
                .map_err(|e| ToolError::new(format!("Failed to get Cloud client: {}", e)))?;

            let handler = DatabaseHandler::new(client);
            let tags = handler
                .get_tags(input.subscription_id, input.database_id)
                .await
                .map_err(|e| ToolError::new(format!("Failed to get tags: {}", e)))?;

            let output = serde_json::to_string_pretty(&tags)
                .map_err(|e| ToolError::new(format!("Failed to serialize: {}", e)))?;

            Ok(CallToolResult::text(output))
        })
        .build()
        .expect("valid tool")
}