Skip to main content
Glama
aliyun

Alibaba Cloud RDS OpenAPI MCP Server

Official
by aliyun

describe_db_instance_ip_allowlist

Read-only

Retrieve IP allowlist configurations for multiple Alibaba Cloud RDS instances to manage network access security and connectivity settings.

Instructions

Batch retrieves IP allowlist configurations for multiple RDS instances.
Args:
    region_id: The region ID of the RDS instance.
    db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
Returns:
    list[dict]: A list of dictionaries containing network configuration details for each instance.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
region_idYes
db_instance_idsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function that implements the 'describe_db_instance_ip_allowlist' tool. It batches API calls to DescribeDBInstanceIPArrayListRequest (the Alibaba Cloud RDS API for IP whitelists/allowlists) for a list of DB instance IDs, returning the IP allowlist configurations for each instance.
    @mcp.tool(annotations=READ_ONLY_TOOL)
    async def describe_db_instance_ip_allowlist(
            region_id: str,
            db_instance_ids: list[str]
    ) -> list[dict]:
        """
        Batch retrieves IP allowlist configurations for multiple RDS instances.
        Args:
            region_id: The region ID of the RDS instance.
            db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
        Returns:
            list[dict]: A list of dictionaries containing network configuration details for each instance.
        """
        try:
            client = get_rds_client(region_id)
            db_instance_ip_allowlist = []
            for db_instance_id in db_instance_ids:
                request = rds_20140815_models.DescribeDBInstanceIPArrayListRequest(
                    dbinstance_id=db_instance_id
                )
                response = await client.describe_dbinstance_iparray_list_async(request)
                db_instance_ip_allowlist.append(response.body.to_map())
            return db_instance_ip_allowlist
        except Exception as e:
            raise e
Behavior4/5

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

The annotations provide readOnlyHint=true, which the description aligns with by using 'retrieves' (a read operation). The description adds valuable behavioral context beyond annotations by specifying it's a batch operation for multiple instances and describing the return format as 'a list of dictionaries containing network configuration details'. This provides helpful implementation guidance that annotations alone don't cover.

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

Conciseness5/5

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

The description is perfectly structured and concise: a clear purpose statement followed by well-organized sections for Args and Returns. Every sentence earns its place by providing essential information without redundancy. The formatting with clear section headers makes it easily scannable and front-loaded with the most important information.

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

Completeness5/5

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

Given the tool's moderate complexity (2 required parameters), the presence of annotations (readOnlyHint), and an output schema (implied by the Returns section), the description is complete enough. It explains what the tool does, documents all parameters with examples, specifies the return format, and provides appropriate context about the batch nature of the operation. No significant gaps remain for agent understanding.

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

Parameters5/5

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

With 0% schema description coverage, the description fully compensates by clearly explaining both parameters: 'region_id' as 'The region ID of the RDS instance' and 'db_instance_ids' as 'List of DB instance identifiers' with a concrete example. This adds essential semantic meaning that the bare schema lacks, making the parameters understandable and actionable.

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 tool's purpose with a specific verb ('Batch retrieves') and resource ('IP allowlist configurations for multiple RDS instances'). It distinguishes from siblings like 'describe_db_instance_attribute' by focusing specifically on IP allowlist configurations rather than general attributes. However, it doesn't explicitly differentiate from all possible similar tools in the sibling list.

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

Usage Guidelines3/5

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

The description implies usage context through the mention of 'multiple RDS instances' and the batch nature of the operation, suggesting this should be used when retrieving IP allowlist configurations for multiple instances at once. However, it doesn't provide explicit guidance on when to use this vs. alternatives like 'describe_db_instance_net_info' or 'describe_instance_linked_whitelist_template', nor does it mention any prerequisites or exclusions.

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