Skip to main content
Glama
aliyun

Alibaba Cloud RDS OpenAPI MCP Server

Official
by aliyun

describe_instance_linked_whitelist_template

Read-only

Retrieve whitelist templates linked to an Alibaba Cloud RDS instance to manage database access controls and security configurations.

Instructions

describe instance linked whitelist template.
Args:
    region_id: The region ID of the RDS instance.
    db_instance_id: The ID of the RDS instance.
Returns:
    dict[str, Any]: The response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
region_idYes
db_instance_idYes

Implementation Reference

  • The main handler function that executes the tool 'describe_instance_linked_whitelist_template'. It uses the RDS OpenAPI client to query the whitelist templates linked to the specified DB instance.
    async def describe_instance_linked_whitelist_template(
            region_id: str,
            db_instance_id: str
    ):
        """
        describe instance linked whitelist template.
        Args:
            region_id: The region ID of the RDS instance.
            db_instance_id: The ID of the RDS instance.
        Returns:
            dict[str, Any]: The response.
        """
        try:
            client = get_rds_client(region_id)
            request = rds_20140815_models.DescribeInstanceLinkedWhitelistTemplateRequest(
                region_id=region_id,
                ins_name=db_instance_id
            )
            response = await client.describe_instance_linked_whitelist_template_async(request)
            return response.body.to_map()
        except Exception as e:
            raise e
Behavior3/5

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

The annotations provide readOnlyHint=true, indicating this is a safe read operation. The description adds minimal behavioral context beyond this, stating it returns a dict response but not detailing what that contains (e.g., template details, status). It doesn't mention error conditions, rate limits, or authentication needs. Since annotations cover the safety profile, the description meets a baseline but lacks enriching details.

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

Conciseness3/5

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

The description is brief and structured with Args and Returns sections, which is efficient. However, it's under-specified—each section provides only basic labels without meaningful elaboration. While not verbose, it lacks the necessary detail to be truly helpful, making it more sparse than concise.

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

Completeness2/5

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

Given the tool's complexity (involving RDS instances and whitelist templates), no output schema, and 0% schema description coverage, the description is inadequate. It doesn't explain what the returned dict contains, how it relates to whitelist functionality, or any error handling. With annotations covering only read-only status, significant gaps remain in understanding the tool's behavior and output.

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

Parameters2/5

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

Schema description coverage is 0%, so the schema provides no parameter details. The description lists the parameters but only repeats their names without explaining what they represent (e.g., what format region_id expects, how db_instance_id is obtained). This adds minimal semantic value, failing to compensate for the schema's lack of descriptions.

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

Purpose2/5

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

The description 'describe instance linked whitelist template' is essentially a tautology that restates the tool name with minimal elaboration. It doesn't specify what 'describe' entails (e.g., retrieving details, listing configurations) or clarify what a 'linked whitelist template' is in this context. While it mentions RDS instance parameters, the core purpose remains vague compared to more specific sibling tools like 'describe_db_instance_attribute' or 'describe_db_instance_ip_allowlist'.

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?

No guidance is provided on when to use this tool versus alternatives. The description doesn't explain its relationship to sibling tools like 'describe_db_instance_ip_allowlist' or 'attach_whitelist_template_to_instance', nor does it specify prerequisites or appropriate contexts. The agent must infer usage from the tool name alone, which is insufficient for informed selection.

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

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/aliyun/alibabacloud-rds-openapi-mcp-server'

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