Skip to main content
Glama
aliyun

Alibaba Cloud DMS MCP Server

Official
by aliyun

optimizeSql

Read-only

Analyze SQL statements and optimize their performance using a database ID. Improve query execution by providing detailed optimization suggestions.

Instructions

Analyze and optimize SQL performance based on the provided SQL statement and database IDIf you don't know the databaseId, first use getDatabase or searchDatabase to retrieve it. (1) If you have the exact host, port, and database name, use getDatabase. (2) If you only know the database name, use searchDatabase. (3) If you don't know any information, ask the user to provide the necessary details. Note: searchDatabase may return multiple databases. In this case, let the user choose which one to use.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
database_idYesDMS databaseId
questionNoNatural language question
sqlYesSQL statement
modelNoOptional: if a specific model is desired, it can be specified here

Implementation Reference

  • Core handler function 'optimize_sql' that implements the SQL optimization logic. It creates a DMS client, builds an OptimizeSqlByMetaAgentRequest, calls the optimize_sql_by_meta_agent API, and returns the response as a dict.
    async def optimize_sql(
            database_id: str = Field(description="DMS databaseId"),
            question: Optional[str] = Field(default=None, description="Natural language question"),
            sql: str = Field(description="SQL statement"),
            model: Optional[str] = Field(default=None,
                                         description="Optional: if a specific model is desired, it can be specified here")
    ) -> Any:
        client = create_client()
        req = dms_enterprise_20181101_models.OptimizeSqlByMetaAgentRequest(db_id=database_id, query=question, sql=sql)
        # if mcp.state.real_login_uid:
        #     req.real_login_user_uid = mcp.state.real_login_uid
        if model:
            req.model = model
        try:
            resp = client.optimize_sql_by_meta_agent(req)
            if not resp or not resp.body:
                return None
            data = resp.body.to_map()
            return data
        except Exception as e:
            logger.error(f"Error in optimize_sql: {e}")
            raise
  • Input schema for optimize_sql: database_id (str), question (Optional[str]), sql (str), model (Optional[str]). Return type is Any (dict from API response).
    async def optimize_sql(
            database_id: str = Field(description="DMS databaseId"),
            question: Optional[str] = Field(default=None, description="Natural language question"),
            sql: str = Field(description="SQL statement"),
            model: Optional[str] = Field(default=None,
                                         description="Optional: if a specific model is desired, it can be specified here")
    ) -> Any:
  • Registration of 'optimizeSql' tool in the configured database toolset (_register_configured_db_toolset). Wraps the core handler with the pre-configured database_id.
    @self.mcp.tool(name="optimizeSql",
                   description="Analyze and optimize SQL performance based on the provided SQL statement",
                   annotations={"title": "SQL优化", "readOnlyHint": True, "destructiveHint": False})
    async def optimize_sql_configured(
            question: Optional[str] = Field(default=None, description="Natural language question"),
            sql: str = Field(description="SQL statement"),
            model: Optional[str] = Field(default=None,
                                         description="Optional: if a specific model is desired, it can be specified here")
    ) -> Any:
        result_obj = await optimize_sql(database_id=self.default_database_id, question=question, sql=sql,
                                        model=model)
        return result_obj
  • Registration of 'optimizeSql' tool in the full toolset (_register_full_toolset). Directly registers the core optimize_sql function with description requiring a database_id.
    self.mcp.tool(name="optimizeSql", description=f"Analyze and optimize SQL performance "
                                                  f"based on the provided SQL statement and database ID"
                                                  f"{DATABASE_ID_DESCRIPTION}",
                  annotations={"title": "SQL优化", "readOnlyHint": True})(optimize_sql)
Behavior4/5

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

Annotations mark readOnlyHint=true, and description says 'optimize' which could imply modification; however, context suggests analysis. Lacks explicit statement that no changes are made to the database. Still mostly transparent given annotations.

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?

Concise first sentence states purpose, followed by clear bullet points for workflow. No redundant information, well-organized.

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?

Covers purpose, prerequisites, and parameter workflow. Lacks description of output/return value, which is important since no output schema exists. Otherwise complete for usage context.

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?

Input schema has 100% coverage with descriptions for all parameters. Description adds value for database_id by providing usage workflow, but does not significantly enhance semantics of other parameters beyond schema.

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?

Clearly states verb 'analyze and optimize', resource 'SQL performance', and required parameters (SQL statement and database ID). Distinguishes from siblings like fixSql, generateSql, answerSqlSyntax.

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

Usage Guidelines5/5

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

Explicit step-by-step guidance on obtaining databaseId using getDatabase or searchDatabase, including fallback to ask user. Also notes that searchDatabase may return multiple results, requiring user selection. Clearly indicates when to use this tool vs alternatives.

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