Skip to content

Deployment: Dockerfile and Smithery config #7

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM node:lts-alpine

# Create app directory
WORKDIR /app

# Install app dependencies
COPY package*.json ./

# Install dependencies without running scripts
RUN npm install --ignore-scripts

# Copy source code
COPY . .

# Build the project
RUN npm run build

# Expose any necessary ports if required (optional, not required by MCP)

# Command to run the MCP server
CMD [ "node", "dist/index.js" ]
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Redis Cloud API MCP Server

[![smithery badge](https://smithery.ai/badge/@redis/mcp-redis-cloud)](https://smithery.ai/server/@redis/mcp-redis-cloud)

Model Context Protocol (MCP) is a standardized protocol for managing context between large language models (LLMs) and external systems. This repository provides an MCP Server for Redis Cloud's API, allowing you to manage your Redis Cloud resources using natural language.

This lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things on your Redis Cloud account, e.g.:
@@ -64,6 +66,13 @@ This lets you use Claude Desktop, or any MCP Client, to use natural language to
- Task IDs are returned for long-running operations and can be monitored
- Paginated responses require multiple calls to retrieve all data

### Installing via Smithery

To install Redis Cloud API MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@redis/mcp-redis-cloud):

```bash
npx -y @smithery/cli install @redis/mcp-redis-cloud --client claude
```

### Claude Desktop

@@ -172,3 +181,4 @@ Note: If you make changes to your code, remember to rebuild and restart Claude D
```bash
npm run build
```

31 changes: 31 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
required:
- apiKey
- secretKey
properties:
apiKey:
type: string
description: Redis Cloud API Key
secretKey:
type: string
description: Redis Cloud API Secret Key
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({
command: 'node',
args: ['dist/index.js'],
env: {
API_KEY: config.apiKey,
SECRET_KEY: config.secretKey
}
})
exampleConfig:
apiKey: dummy_api_key
secretKey: dummy_secret_key