list-api

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

With no annotations provided, the description carries the full burden. It explicitly says the tool 'only returns a list' and clarifies that actual database construction and operations happen afterward by the agent, which communicates that this tool is read-only and non-mutating.

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 reasonably concise and front-loads the usage condition, then states the behavior and expected follow-up. There is slight redundancy in repeating '根据你的业务需求', but overall it is direct and efficient.

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?

This is a zero-parameter listing tool with no output schema and no annotations. The description covers when to use it, what it returns, and what the agent should do after calling it, which is enough for an agent to start correctly. It does not describe the list's format, but for a simple list-API tool that is a minor gap.

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 tool has no parameters, so the description does not need to explain parameter details. The baseline of 4 applies, and nothing in the description contradicts the empty schema.

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 that the tool returns a list of framework-available APIs for Mybatis-Flex database operations. It identifies a specific verb and resource, but does not explicitly differentiate itself from sibling tools like get-api-doc or get-mybatis-flex-info.

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 gives a clear context for use: when the user is doing backend development with Mybatis-Flex and needs to perform database operations. It does not mention alternatives or exclusion conditions, so it stops short of a 5.

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