Skip to main content
Glama
aliyun

Alibaba Cloud RDS OpenAPI MCP Server

Official
by aliyun

describe_db_instance_attribute

Read-only

Query detailed configuration and status information for a specific Alibaba Cloud RDS database instance to monitor its attributes and settings.

Instructions

Queries the details of an instance.
Args:
    region_id: db instance region(e.g. cn-hangzhou)
    db_instance_id: db instance id(e.g. rm-xxx)
:return:

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
region_idYes
db_instance_idYes

Implementation Reference

  • The main handler function for the 'describe_db_instance_attribute' tool. It calls the Alibaba Cloud RDS OpenAPI to retrieve detailed attributes of a specified DB instance.
    @mcp.tool(annotations=READ_ONLY_TOOL)
    async def describe_db_instance_attribute(region_id: str, db_instance_id: str):
        """
        Queries the details of an instance.
        Args:
            region_id: db instance region(e.g. cn-hangzhou)
            db_instance_id: db instance id(e.g. rm-xxx)
        :return:
        """
        client = get_rds_client(region_id)
        try:
            request = rds_20140815_models.DescribeDBInstanceAttributeRequest(dbinstance_id=db_instance_id)
            response = client.describe_dbinstance_attribute(request)
            return response.body.to_map()
        except Exception as e:
            raise e
  • The @mcp.tool decorator registers this function as the MCP tool named 'describe_db_instance_attribute'.
    @mcp.tool(annotations=READ_ONLY_TOOL)
  • Helper function to create and return the RDS OpenAPI client used in the handler.
    "sqlserver": {
        "MemCpuUsage": ["SQLServer_CPUUsage"],
        "QPSTPS": ["SQLServer_QPS", "SQLServer_IOPS"],
        "Sessions": ["SQLServer_Sessions"],
        "COMDML": [],
Behavior3/5

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

The description adds minimal behavioral context beyond the annotations. The annotation 'readOnlyHint: true' already indicates this is a safe read operation. The description confirms it's a query (non-destructive) but does not disclose additional traits like rate limits, authentication needs, or what specific details are returned. No contradiction with annotations exists, but the description provides limited extra value.

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 appropriately sized and front-loaded, starting with the core purpose in the first sentence. The parameter list is structured with 'Args:' and ':return:', making it easy to scan. However, the ':return:' section is empty, which is a minor structural inefficiency, but overall, it avoids unnecessary verbosity.

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?

Given the tool's complexity (a read operation with 2 parameters), the annotations cover safety (readOnlyHint), but there is no output schema. The description mentions a return but leaves it undefined, which is a significant gap. It provides basic parameter info but lacks details on what 'details' are queried or the response format, making it incomplete for effective agent use.

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?

The description lists the two parameters with brief examples (e.g., 'cn-hangzhou', 'rm-xxx'), adding some semantic meaning beyond the schema, which has 0% description coverage. However, it does not fully explain what 'region_id' or 'db_instance_id' represent in context (e.g., cloud region, database instance identifier), leaving gaps in understanding. With low schema coverage, the description partially compensates but not comprehensively.

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 as 'Queries the details of an instance' with a specific verb ('queries') and resource ('instance'), distinguishing it from siblings like 'describe_db_instances' (plural) or 'describe_db_instance_performance'. However, it doesn't explicitly differentiate from other 'describe_' siblings that also query instance attributes, such as 'describe_db_instance_net_info' or 'describe_db_instance_parameters', which slightly reduces clarity.

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. It does not mention any prerequisites, context for usage, or comparisons to sibling tools like 'describe_db_instances' (which might list instances) or other 'describe_' tools that query specific aspects of an instance. This leaves the agent without explicit direction on tool 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