find_instance_by_ip

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

No annotations are provided, so the description carries full burden. It discloses that it searches both TDSQL-C and TDSQL instances, returns matching info or 'not found', and is part of a workflow implying it is read-only. However, it does not explicitly state it is a read operation or mention authorization needs.

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

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

The description is concise, well-structured, and front-loaded: first line defines purpose, then typical workflow, then parameter details, then return value. Every sentence serves a purpose.

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

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

For a 2-parameter lookup tool with no annotations, the description covers purpose, usage, parameters, and return value (including fields returned). The typical workflow provides additional context for the expected use.

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

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

The input schema has 0% description coverage. The description adds meaning by providing examples for ip ('10.0.0.1') and region ('ap-shanghai', 'ap-beijing'), and clarifies that region defaults to 'ap-shanghai' and must match the deployment region.

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

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

The description clearly states the tool finds a database instance by its internal Vip (proxy IP), and distinguishes it from sibling tools like execute_select or login_instance by specifying it returns InstanceId for further use.

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

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

The description provides a typical workflow: read JDBC URL, call this tool to get InstanceId, then login_instance. It also specifies that region must match the cluster region, guiding correct usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.