byted-redis

Volcengine Redis MCP Server Skill

Purpose

Use this skill as the agent-facing workflow for Volcengine Redis cloud resource operations. The skill bundles MCP client scripts, startup scripts, credential guidance, and tool-selection instructions so agents can perform Volcengine Redis resource queries and management tasks.

This skill is scoped to Volcengine Redis only. Redis-related requests outside Volcengine, such as OSS Redis command execution, self-hosted Redis troubleshooting, application cache logic, Redis running in Kubernetes, or non-Volcengine cloud Redis products, should use other tools or skills.

Triggering Rules

Use this skill when the user asks for Volcengine Redis tasks such as:

• Redis instance inventory, detail lookup, status lookup, filtering by region, instance ID, name, tag, VPC, or subnet.
• Region, zone, VPC, subnet, EIP, spec, shard, node ID, endpoint, bandwidth, or topology information.
• Slow log, hot key, big key, key scan job, planned event, or operational metadata queries.
• Backup, PITR, cross-region backup, backup plan, or backup download URL queries.
• Parameter group, instance parameter, ACL command/category, account, or allowlist operations.
• Creating or modifying Volcengine Redis resources, including instances, accounts, allowlists, public endpoints, names, and parameters.

Do not use this skill for generic Redis command execution against a data endpoint, application-side cache debugging, Kubernetes pod metadata lookup, self-hosted Redis, other cloud providers' Redis products, or any non-Volcengine Redis resource unless the user explicitly says the target is Volcengine Redis.

Execution Workflow

1. Classify the request as read-only or mutating.
2. Check the required identifiers. Prefer explicit region_id and instance_id when available. If the user gives only a name or vague keyword, first call describe_db_instances with region and filter arguments, then use the returned instance ID for detail tools.
3. Verify credentials are available before starting MCP:
   • AUTHORIZATION or authorization, or
   • VOLCENGINE_ACCESS_KEY and VOLCENGINE_SECRET_KEY, with optional VOLCENGINE_SESSION_TOKEN.
4. If the region is not supplied, use VOLCENGINE_REGION when set. If neither the user nor the environment gives a region, ask for the region before making region-scoped calls. Prefer region-scoped discovery tools such as describe_zones or describe_db_instances once the region is known.
5. Use the bundled client in scripts/mcp_client.py for custom calls. For a smoke test, run uv run scripts/call_redis_mcp_example.py from this skill directory.
6. For mutating operations, summarize the target resource and intended change, then ask for user confirmation before calling the tool unless the user has already clearly authorized that exact mutation.
7. Return concise results with the resource identifiers, region, status, and the fields relevant to the user's question. Mention when output was filtered or truncated.