Skip to main content

MCP server for managing Alibaba Cloud R-KVStore (Tair/Redis) via OpenAPI

Project description

English | 中文

Alibaba Cloud Tair OpenAPI MCP Server

PyPI version Python

MCP server for managing Alibaba Cloud R-KVStore (Tair/Redis) via OpenAPI

Prerequisites

  1. Python >=3.12
  2. Alibaba Cloud credentials with access to Alibaba Cloud R-KVStore services
  3. Cline MCP client (recommended) or other MCP-compatible client

Installation

Option 1: Install from PyPI

pip install alibabacloud-tair-openapi-mcp-server

Option 2: Install from Source with UV

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install
git clone https://github.com/aliyun/alibabacloud-tair-mcp-server.git
cd alibabacloud-tair-mcp-server/tair_openapi_mcp_server
uv venv
source .venv/bin/activate
uv pip install -e .

Quick Start

Setup with Cline (Recommended)

  1. Install the server (using PyPI or UV as shown above)

  2. Configure Cline by adding this to your Cline configuration:

{
  "mcpServers": {
    "tair-openapi": {
      "command": "tair-openapi-mcp-server",
      "args": [],
      "env": {
        "ALIBABA_CLOUD_ACCESS_KEY_ID": "your-access-key-id",
        "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "your-access-key-secret"
      }
    }
  }
}

Replace the credentials with your actual Alibaba Cloud access keys.

Available OpenAPI MCP Tools

Resources

  • describe_regions: List all available regions for Alibaba Cloud Tair instances
  • describe_zones: Query available zones in a region for Tair instances
  • describe_available_resource: Query available instance specifications in a specific zone
  • describe_vpcs: Query VPC (Virtual Private Cloud) list in a region
  • describe_vswitches: Query VSwitch (Virtual Switch) list in a region

Instance Creation

  • create_instance: Create a Redis Community Edition or Tair Enterprise Edition Classic instance
  • create_tair_instance: Create a Tair Enterprise Edition cloud-native instance

Account Management

  • describe_accounts: Query account information for a Tair instance
  • reset_account_password: Reset the password for a Tair account with security validation

IP Whitelist

  • describe_security_ips: Query IP whitelist configuration for a Tair instance
  • modify_security_ips: Modify IP whitelist for a Tair instance

Configuration Options

Environment Variables

Variable Description Default Required
ALIBABA_CLOUD_ACCESS_KEY_ID Alibaba Cloud Access Key ID - Yes
ALIBABA_CLOUD_ACCESS_KEY_SECRET Alibaba Cloud Access Key Secret - Yes
TAIR_MCP_LOG_LEVEL Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL) INFO No
TAIR_MCP_LOG_FILE Optional log file path - No

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Support

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alibabacloud_tair_openapi_mcp_server-0.1.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file alibabacloud_tair_openapi_mcp_server-0.1.1.tar.gz.

File metadata

File hashes

Hashes for alibabacloud_tair_openapi_mcp_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c778fb6e79b222d222ba2f4132e3a5e09b412405d2c3fa3f79f7dd847e350262
MD5 d361556e2848aed6b6abd8699fce1137
BLAKE2b-256 47effa5208354396624d2d7d60c75eb036a8b8dfe6596a5d0d7f1eee9d426929

See more details on using hashes here.

File details

Details for the file alibabacloud_tair_openapi_mcp_server-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for alibabacloud_tair_openapi_mcp_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9feb1624eadbe615b873bfd3a245e97d75a11e546f1c1fcfc1780f5a1abcbcc2
MD5 f9ff338a4f396851388995bc7e855e5f
BLAKE2b-256 02526d5541d4f276f783b519e83f06d08566206b9c3db1b9e2b6355bcb608414

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page