Skip to main content
Glama
redis

Redis Cloud API MCP Server

Official
by redis

get-pro-subscription

Retrieve a pro subscription by ID using the Redis Cloud API MCP Server. Ensure the payload matches the required input schema for successful execution.

Instructions

Get pro subscription by ID. The payload must match the input schema.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
subscriptionIdYesSubscription ID

Implementation Reference

  • The main handler function for the 'get-pro-subscription' tool. It extracts the subscriptionId from the input, validates it using subscriptionIdSchema, calls the SubscriptionsProService.getSubscriptionById API, and returns the result wrapped in createToolResponse.
    "get-pro-subscription": async (request) => {
      const { subscriptionId } = extractArguments<{
        subscriptionId: number;
      }>(request);
    
      // Validate input
      validateToolInput(
        subscriptionIdSchema,
        subscriptionId,
        `Get pro subscription: ${subscriptionId}`,
      );
    
      const result = await executeApiCall(
        () => SubscriptionsProService.getSubscriptionById(subscriptionId),
        `Get pro subscription: ${subscriptionId}`,
      );
    
      return createToolResponse(result);
    },
  • Tool definition including the name, description, and input schema for 'get-pro-subscription', which requires a subscriptionId (number, min 1).
    const GET_PRO_SUBSCRIPTION_TOOL: Tool = {
      name: "get-pro-subscription",
      description:
        "Get pro subscription by ID. The payload must match the input schema.",
      inputSchema: {
        type: "object",
        properties: {
          subscriptionId: {
            type: "number",
            description: "Subscription ID",
            min: 1,
          },
        },
        required: ["subscriptionId"],
      },
    };
  • Local registration of the get-pro-subscription tool in the SUBSCRIPTIONS_PRO_TOOLS array export.
    export const SUBSCRIPTIONS_PRO_TOOLS = [
      CREATE_PRO_SUBSCRIPTION_TOOL,
      GET_PRO_SUBSCRIPTIONS_TOOL,
      GET_PRO_SUBSCRIPTION_TOOL,
    ];
  • src/index.ts:40-47 (registration)
    Global registration where SUBSCRIPTIONS_PRO_TOOLS (including get-pro-subscription) is spread into ALL_TOOLS for the MCP server listTools handler.
    const ALL_TOOLS = [
      ...ACCOUNT_TOOLS,
      ...SUBSCRIPTIONS_PRO_TOOLS,
      ...SUBSCRIPTIONS_ESSENTIALS_TOOLS,
      ...TASKS_TOOLS,
      ...DATABASES_PRO_TOOLS,
      ...DATABASES_ESSENTIALS_TOOLS,
    ];
  • src/index.ts:49-56 (registration)
    Global registration where SUBSCRIPTIONS_PRO_HANDLERS (including get-pro-subscription handler) is spread into ALL_HANDLERS for the MCP server callTool handler.
    const ALL_HANDLERS = {
      ...ACCOUNT_HANDLERS,
      ...SUBSCRIPTIONS_ESSENTIALS_HANDLERS,
      ...SUBSCRIPTIONS_PRO_HANDLERS,
      ...TASKS_HANDLERS,
      ...DATABASES_PRO_HANDLERS,
      ...DATABASES_ESSENTIALS_HANDLERS,
    };
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states this is a 'Get' operation, implying read-only behavior, but doesn't clarify authentication requirements, error handling, rate limits, or what happens if the subscription ID doesn't exist. The description adds minimal behavioral context beyond the basic operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is brief (two sentences) and front-loaded with the core purpose. The second sentence about payload matching the schema is somewhat redundant given the schema documentation, but doesn't significantly detract from conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read operation with one parameter and no output schema, the description provides basic purpose but lacks important context. Without annotations or output schema, it should ideally clarify what information is returned about the subscription, error conditions, or how this differs from similar tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the single parameter 'subscriptionId' clearly documented in the schema. The description adds no additional parameter information beyond what's already in the structured schema, so it meets the baseline expectation without adding extra value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get') and resource ('pro subscription by ID'), making the purpose understandable. However, it doesn't differentiate this tool from its sibling 'get-pro-subscriptions' (plural), which appears to retrieve multiple subscriptions rather than a single one by ID.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'get-pro-subscriptions' or 'get-essential-subscription-by-id'. It mentions that 'The payload must match the input schema', but this is a generic requirement rather than specific usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/redis/mcp-redis-cloud'

If you have feedback or need assistance with the MCP directory API, please join our Discord server