Package Exports
- valkey-glidejs-mcp
- valkey-glidejs-mcp/dist/server.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (valkey-glidejs-mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
๐ Valkey GLIDE MCP Server
A streamlined Model Context Protocol (MCP) server for Valkey GLIDE - providing intelligent migration assistance, code generation, and complete API coverage for AI assistants.
โจ Smart Tool Architecture
๐ง 4 Intelligent Tools
| Tool | Purpose | Key Features |
|---|---|---|
api |
API exploration & search | Context-aware search, smart filtering |
generate |
Code generation | Pattern detection, parameter inference |
migrate |
Migration engine | Complexity assessment, automatic routing |
system |
System utilities | Health, validation, docs, debugging |
๐ง Intelligent Features
- Smart Parameter Detection: Tools automatically understand your intent
- Context-Aware Routing: Responses adapt based on query complexity
- Unified Interfaces: Consistent experience across all operations
โจ Features at a Glance
๐ฏ Complete API Coverage: 673 methods across all GLIDE-supported commands
๐ Smart Migration: 100% success rate on 65+ tested migration patterns
โก Comprehensive Commands: Support for 296 commands supported by GLIDE
๐๏ธ Intelligent Generation: Context-aware code templates for all use cases
โ
Runtime Validated: All migrations tested against live Valkey instances
๐ง Production Ready: Based on actual GitHub repositories, not toy examples
๐ง AI-Optimized: Streamlined tool interface reduces cognitive load
๐ฏ What This Tool Does
This MCP server transforms AI assistants (Claude, Continue, Cline, Zed, etc.) into Valkey GLIDE experts by providing:
- ๐ Universal Migration: Seamlessly convert any ioredis/node-redis code to GLIDE
- ๐๏ธ Smart Code Generation: Generate production-ready GLIDE code for any pattern
- ๐ Complete API Knowledge: Instant access to all 673 GLIDE methods and their usage
- ๐ฏ Pattern Recognition: Handle complex real-world scenarios (locks, rate limiting, pub/sub, transactions)
- โ Validation Tools: Verify code correctness and API compliance
๐ Quick Start
One-Command Installation
# Install globally (recommended)
npm install -g valkey-glidejs-mcp
# Or use with npx (no installation)
npx valkey-glidejs-mcp@latest๐ง Setup for AI Assistants
๐ฑ Claude Desktop / Claude Code
Option 1: Using Claude Code CLI (Recommended)
# Current published package has missing files - use local development method:
clone https://github.com/avifenesh/valkey-glidejs-mcp.git
cd valkey-glidejs-mcp
npm install
# Then use in Claude:
claude mcp add --scope user valkey-glide npx tsx /path/to/valkey-glidejs-mcp/src/server.tsAlternative (once fixed package is published):
claude mcp add --scope user valkey-glidejs-mcp npx valkey-glidejs-mcp@latestOption 2: Manual Configuration Add to your Claude Desktop config file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
Current Workaround (until package fix):
{
"mcpServers": {
"valkey-glide": {
"command": "npx",
"args": ["tsx", "/full/path/to/valkey-glidejs-mcp/src/server.ts"]
}
}
}Future (once package is fixed):
{
"mcpServers": {
"valkey-glide": {
"command": "npx",
"args": ["valkey-glidejs-mcp@latest"]
}
}
}Then restart Claude Desktop.
๐ Other MCP-Compatible Tools
Configuration:
- Command:
npxorvalkey-glidejs-mcp(if globally installed) - Args:
["valkey-glidejs-mcp@latest"](only if usingnpx) - Transport:
stdio
Supported Tools: Continue, Cline, Zed, and any MCP-compatible AI assistant
๐ฌ What You Can Ask
Describe what you need - the system automatically routes to the right functionality:
๐ Migration
"Migrate this ioredis code to GLIDE"
"Convert my node-redis app to use GLIDE"
"How do I migrate Redis pipelines to GLIDE batch operations?"๐๏ธ Code Generation
"Create a GLIDE client for my app"
"Generate a distributed lock with GLIDE"
"Build a rate limiter using GLIDE and streams"
"Show me pub/sub patterns with GLIDE"๐ API Documentation
"What GLIDE methods work with sorted sets?"
"How do I use GLIDE for geospatial operations?"
"Show me all available GLIDE string commands"
"Find GLIDE equivalent for ioredis.get()"๐ง System Operations
"Check server health"
"Validate this GLIDE code"
"Show documentation for caching patterns"
"Debug this Redis connection"๐ง Smart Tool Architecture
๐ง Intelligent Tool Consolidation
4 smart tools with context-aware routing for optimal AI agent experience:
| Smart Tool | Capabilities | Intelligence Features |
|---|---|---|
api |
Search, equivalents, categories, browsing | โข Query complexity detection โข Smart result filtering โข Context-aware responses |
generate |
Clients, patterns, applications, advanced | โข Parameter inference โข Pattern recognition โข Complexity-based routing |
migrate |
ioredis, node-redis transformations | โข Source detection โข Pattern analysis โข Smart transformations |
system |
Health, validation, docs, debugging | โข Action inference โข Error detection โข Help routing |
๐ Universal Migration Engine (migrate tool)
Complete Client Support: Handles both ioredis and node-redis with 65+ tested migration patterns
- โ URL Parsing: Automatic redis:// and rediss:// URL handling with TLS/auth extraction
- โ Smart Config Mapping: Intelligent conversion of connection options and retry strategies
- โ Batch Processing: Converts deprecated pipelines to GLIDE Batch with non-atomic execution
- โ Transaction Translation: Converts multi/exec to GLIDE Batch with atomic guarantees
- โ
Script Migration: Transforms
redis.eval()to GLIDE Script objects with proper scoping - โ Pub/Sub Conversion: Complete event-driven pattern migration with examples
- โ Native Operations: Direct mapping to GLIDE's native blocking and atomic operations
๐๏ธ Intelligent Code Generation (generate tool)
Production-Ready Templates for every Valkey use case:
- Client Setup: Standalone, cluster, and advanced configurations
- Data Structures: Strings, hashes, lists, sets, sorted sets, streams, geo, bitmaps, HyperLogLog, JSON
- Advanced Patterns: Distributed locks, rate limiters, caching, pub/sub, transactions
- Real-World Scenarios: Session management, job queues, idempotency, circuit breakers
๐ Complete API Coverage (api tool)
673 Methods with comprehensive documentation:
- ๐ Smart Search: Find any method by name, category, or functionality
- ๐ Category Browsing: Organized by command families (strings, lists, sets, etc.)
- ๐ Detailed Docs: Usage examples, parameters, and return types for every method
- โ Validation Tools: Verify API usage and code correctness
๐ง System Utilities (system tool)
Unified Management: Health, validation, documentation, and debugging
- โค๏ธ Health Monitoring: Server status and performance metrics
- ๐ Code Validation: Static analysis and GLIDE compliance checking
- ๐ Documentation: Context-aware help and examples
- ๐ Debugging: Parameter validation and error diagnosis
๐โโ๏ธ Quick Example
import { GlideClient } from "@valkey/valkey-glide";
// Create client with smart configuration
const client = await GlideClient.createClient({
addresses: [{ host: "localhost", port: 6379 }],
// GLIDE automatically handles retries and optimization
});
// All operations are fully typed and validated
await client.set("user:1001", JSON.stringify({ name: "Alice", age: 30 }));
const userData = await client.get("user:1001");
// Advanced operations work seamlessly
await client.zadd("leaderboard", { alice: 95, bob: 87, charlie: 92 });
// Retrieve top 3 scores in reverse order using a range-by-index query
const topPlayers = await client.zrange(
"leaderboard",
{ start: 0, end: 2, type: "byIndex" },
{ reverse: true },
);
// Clean shutdown
client.close();๐ Performance & Quality Metrics
| Metric | Value | Description |
|---|---|---|
| API Coverage | 673 methods | Complete GLIDE API surface |
| Command Support | 296 commands | GLIDE-supported commands |
| Migration Success | 100% | Tested on 65+ migration patterns |
| Test Coverage | 65+ patterns | Real GitHub repository code |
| Runtime Validation | โ Live testing | Against actual Valkey instances |
| Smart Tools | 4 unified tools | Context-aware routing |
๐ฏ Key Differences from ioredis/node-redis
| Aspect | ioredis/node-redis | GLIDE | Migration Help |
|---|---|---|---|
| Geo Commands | Arrays | Maps | โ Auto-converted |
| Scan Results | Objects | [cursor, keys[]] |
โ Format adjusted |
| Batching | Pipeline chains | Batch(false) | โ Non-atomic exec |
| Transactions | Multi/exec | Batch(true) | โ Atomic execution |
| Clustering | Same client | GlideClusterClient |
โ Auto-detected |
| Scripts | Direct eval | Script objects | โ Properly scoped |
๐ป Development & Contributing
Build from Source
# Clone and setup
git clone https://github.com/avifenesh/valkey-glidejs-mcp.git
cd valkey-glidejs-mcp
npm install
npm run build
# Run comprehensive tests (65+ migration patterns)
npm test
# Validate API mappings
npm run validate:glide
# Ingest latest command documentation
npm run ingest:commandsContributing
We welcome contributions! See CONTRIBUTING.md for:
- ๐ Commit message guidelines
- ๐ Development workflow
- ๐งช Testing requirements
- ๐ Documentation standards
๐ License & Links
License: MIT
Resources:
- ๐ฆ NPM Package
- ๐ Valkey GLIDE wiki
- ๐ Migration Guide
- ๐ Valkey GLIDE Documentation
- ๐ Model Context Protocol
- ๐ Issues & Feedback
Made with โค๏ธ for the Valkey community
Empowering AI assistants with complete Valkey GLIDE knowledge