Skip to content

Commit

Permalink
chore: rename commands
Browse files Browse the repository at this point in the history
  • Loading branch information
ytkimirti committed Jan 12, 2025
1 parent 8e71bf8 commit 0ff6175
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Upstash MCP Server

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

Model Context Protocol (MCP) is a [new, standardized protocol](https://modelcontextprotocol.io/introduction) for managing context between large language models (LLMs) and external systems. In this repository, we provide an installer as well as an MCP Server for [Upstash Developer API's](https://upstash.com/docs/devops/developer-api).
Expand All @@ -20,6 +21,7 @@ This lets you use Claude Desktop, or any MCP Client, to use natural language to
- [Upstash API key](https://upstash.com/docs/devops/developer-api) - You can create one from [here](https://console.upstash.com/account/api).

## How to use locally

### Installing via Smithery

To install Upstash for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@upstash/mcp-server-upstash):
Expand All @@ -29,6 +31,7 @@ npx -y @smithery/cli install @upstash/mcp-server-upstash --client claude
```

### Installing manually

1. Run `npx @upstash/mcp-server-upstash init <UPSTASH_EMAIL> <UPSTASH_API_KEY>`
2. Restart Claude Desktop
3. You should now be able to use Upstash commands in Claude Desktop
Expand All @@ -54,7 +57,8 @@ See the [troubleshooting guide](https://modelcontextprotocol.io/quickstart#troub
- `redis_database_run_single_redis_command`
- `redis_database_set_daily_backup`
- `redis_database_update_regions`
- `redis_database_get_usage_stats`
- `redis_database_get_usage_last_5_days`
- `redis_database_get_stats`

## Development

Expand Down
4 changes: 2 additions & 2 deletions src/tools/redis/db.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ ${GENERIC_DATABASE_NOTES}
},
}),

redis_database_get_last_5_days_usage: tool({
redis_database_get_usage_last_5_days: tool({
description: `Get PRECISE command count and bandwidth usage statistics of an Upstash redis database over the last 5 days (calculated according to UTC+0). This is a precise stat, not an average.
NOTE: Mention that times are in UTC+0 in the response
NOTE: Ask user first if they want to see stats for each database seperately or just for one`,
Expand All @@ -155,7 +155,7 @@ NOTE: Ask user first if they want to see stats for each database seperately or j
},
}),

redis_database_get_usage_stats: tool({
redis_database_get_stats: tool({
description: `Get SAMPLED usage statistics of an Upstash redis database over a period of time (1h, 3h, 12h, 1d, 3d, 7d). Use this to check for peak usages and latency problems.
Includes: read_latency_mean, write_latency_mean, keyspace, throughput (cmds/sec), diskusage`,
inputSchema: z.object({
Expand Down

0 comments on commit 0ff6175

Please sign in to comment.