Skip to main content
Glama
aliyun

Alibaba Cloud RDS OpenAPI MCP Server

Official
by aliyun

describe_db_instance_net_info

Read-only

Retrieve network configuration details for multiple Alibaba Cloud RDS database instances to manage connectivity and security settings.

Instructions

Batch retrieves network configuration details 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 implementing the 'describe_db_instance_net_info' MCP tool. It takes a region_id and list of db_instance_ids, creates an RDS client, loops over each instance ID to call the DescribeDBInstanceNetInfo API via the SDK, and returns a list of network info maps for each instance.
    async def describe_db_instance_net_info(
            region_id: str,
            db_instance_ids: list[str]
    ) -> list[dict]:
        """
        Batch retrieves network configuration details 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_net_infos = []
            for db_instance_id in db_instance_ids:
                request = rds_20140815_models.DescribeDBInstanceNetInfoRequest(
                    dbinstance_id=db_instance_id
                )
                response = await client.describe_dbinstance_net_info_async(request)
                db_instance_net_infos.append(response.body.to_map())
            return db_instance_net_infos
        except Exception as e:
            raise e
Behavior4/5

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

Annotations provide readOnlyHint=true, which the description aligns with by using 'retrieves' (a read operation). The description adds valuable context beyond annotations: it specifies batch retrieval (multiple instances) and the return format (list of dictionaries with network configuration details), which helps the agent understand the tool's behavior and output structure.

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 front-loaded with the core purpose, followed by clear sections for Args and Returns. Every sentence earns its place by providing essential information without redundancy, and the structure enhances readability for an AI agent.

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

Completeness4/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 parameters, batch operation), the description is reasonably complete: it covers purpose, parameters, and return format. With an output schema present, it doesn't need to detail return values extensively, but it could benefit from more usage guidance or error handling context.

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

Parameters4/5

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

With 0% schema description coverage, the description compensates by explaining both parameters: region_id ('The region ID of the RDS instance') and db_instance_ids ('List of DB instance identifiers' with examples). This adds meaningful semantics beyond the bare schema, though it doesn't detail format constraints or validation rules.

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

Purpose5/5

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

The description clearly states the specific action ('Batch retrieves') and resource ('network configuration details for multiple RDS instances'), distinguishing it from sibling tools like describe_db_instance_attribute or describe_db_instances which have different scopes. The verb+resource combination is precise and unambiguous.

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 'Batch retrieves' and the parameter names, suggesting this is for fetching network details in bulk. However, it doesn't explicitly state when to use this tool versus alternatives like describe_db_instance_attribute or describe_db_instances, nor does it provide exclusion criteria or prerequisites.

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