Skip to main content
Glama
aliyun

Alibaba Cloud DMS MCP Server

Official
by aliyun

getOrderInfo

Read-only

Retrieve order details from Alibaba Cloud DMS using the order ID to access database metadata and query information.

Instructions

Retrieve order information from DMS using the order ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
order_idYesDMS order ID

Implementation Reference

  • The main handler function for the 'getOrderInfo' tool. It takes an order_id parameter, creates a DMS client request, calls the Alibaba Cloud DMS API to get order base info, and returns the response as a dict.
    async def get_order_base_info(
            order_id: str = Field(description="DMS order ID")
    ) -> Dict[str, Any]:
        client = create_client()
        req = dms_enterprise_20181101_models.GetOrderBaseInfoRequest()
        req.order_id = order_id
        try:
            resp = client.get_order_base_info(req)
            return resp.body.to_map()
        except Exception as e:
            logger.error(f"Error in get_order_base_info: {e}")
            raise
  • Registration of the 'getOrderInfo' tool in the configured database toolset (used when a default database ID is set). Applies the tool decorator to the get_order_base_info handler.
    self.mcp.tool(name="getOrderInfo", description="Retrieve order information from DMS using the order ID.",
                  annotations={"title": "获取DMS工单详情", "readOnlyHint": True})(get_order_base_info)
  • Registration of the 'getOrderInfo' tool in the full toolset (used when no default database ID is set). Applies the tool decorator to the get_order_base_info handler.
    self.mcp.tool(name="getOrderInfo", description="Retrieve order information from DMS using the order ID.",
                  annotations={"title": "获取DMS工单详情", "readOnlyHint": True})(get_order_base_info)
Behavior3/5

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

Annotations provide readOnlyHint=true, indicating it's a safe read operation, which the description aligns with by using 'Retrieve'. The description adds minimal context beyond annotations, specifying the data source ('from DMS') and key parameter ('order ID'), but lacks details on rate limits, error handling, or return format. No contradiction with annotations exists.

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 a single, clear sentence with zero waste—it directly states the tool's purpose without unnecessary words. It's front-loaded and efficiently communicates the core functionality, making it easy for an agent to parse quickly.

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 simplicity (1 parameter, read-only per annotations, no output schema), the description is adequate but minimal. It covers the basic purpose and parameter use, but lacks context on error cases, return structure, or integration with sibling tools. For a straightforward retrieval tool, this is acceptable but not comprehensive.

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 parameter 'order_id' fully documented in the schema. The description adds marginal value by reiterating the use of 'order ID' but doesn't provide additional semantics like format examples or constraints beyond what the schema already states. Baseline score of 3 is appropriate given high schema coverage.

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 ('Retrieve') and resource ('order information from DMS'), specifying it uses an order ID. It distinguishes from siblings like 'createDataChangeOrder' or 'submitOrderApproval' by being a read operation, though it doesn't explicitly contrast with similar read tools like 'getDatabase' or 'getInstance'.

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. While it implies usage for retrieving order details, it doesn't mention prerequisites (e.g., needing a valid order ID) or exclusions (e.g., not for modifying orders). The context of sibling tools suggests potential overlaps (e.g., with 'getDatabase' for database info), but no explicit alternatives are named.

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-dms-mcp-server'

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