Skip to content

docs: qualify README API coverage and raw access claims #1185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshrotenberg merged 2 commits into from
Oct 9, 2026
+7 −5
Merged

docs: qualify README API coverage and raw access claims #1185

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
969d8e0
chore: start bounded coverage claims cleanup (#1085)
joshrotenberg Oct 7, 2026
bc3c40b
docs: qualify README API coverage and raw access claims
joshrotenberg Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The `cloud`/`enterprise` prefix is optional -- the CLI infers the platform from

## MCP Server

`redisctl-mcp` exposes 300+ tools to AI assistants (Claude Desktop, Cursor, VS Code, or any MCP client). It covers the full Cloud and Enterprise APIs plus direct Redis database operations -- all with a safety-first policy system.
`redisctl-mcp` exposes 300+ tools to AI assistants (Claude Desktop, Cursor, VS Code, or any MCP client). It provides Cloud and Enterprise management tools plus direct Redis database operations -- all with a safety-first policy system.

### Set Up

Expand Down Expand Up @@ -125,25 +125,27 @@ See the [MCP documentation](https://redis-field-engineering.github.io/redisctl-d

## What's Covered

### Redis Cloud -- Full API Coverage
Coverage varies by product/API version and between CLI commands and MCP tools. The areas below do not guarantee that every upstream endpoint is implemented or live-tested. A versioned [support and validation matrix](https://github.com/redis/redisctl/issues/1085) remains part of 1.0 readiness.

### Redis Cloud Management

Subscriptions, databases, VPC peering, Transit Gateway, PrivateLink, Private Service Connect, ACLs, cloud accounts, tasks, and async operations.

### Redis Enterprise -- Full API Coverage
### Redis Enterprise Management

Clusters, nodes, shards, databases (BDBs), Active-Active (CRDBs), users, roles, LDAP, logs, metrics, alerts, support packages, and diagnostics.

### Database Tools

Connect directly to any Redis instance for key inspection, data structure operations, server diagnostics, and health checks. Available in both the CLI and MCP server.
Connect directly to Redis for key inspection, data structure operations, server diagnostics, and health checks. Available in both the CLI and MCP server.

### Key Capabilities

- **Async operations** -- `--wait` automatically polls long-running operations to completion
- **Output formats** -- tables, JSON, YAML, with JMESPath filtering (`-q`)
- **Profiles** -- manage multiple environments with optional keyring-backed credential storage
- **Workflows** -- high-level commands that compose multi-step operations (e.g., `subscription-setup`)
- **Raw API access** -- `redisctl api cloud get /subscriptions/12345` for any endpoint
- **Raw API access** -- `redisctl api cloud get /subscriptions/12345` sends a REST request; endpoint availability, payloads, and permissions depend on the upstream service
- **Streaming** -- `--follow` for real-time log tailing

---
Expand Down
Loading