Generate Mapper Context

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

The description explicitly states 'read-only', implying no side effects or mutations. However, with no annotations, it does not disclose additional behavioral traits like authentication requirements, rate limits, or what happens with invalid inputs. It is adequate but minimal.

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 very concise (one sentence) and front-loaded. However, given the complexity (9 parameters, 0% schema descriptions), the conciseness sacrifices necessary detail. It is not overly verbose, but lacks completeness.

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 tool with 9 parameters, no output schema, and no annotation, the description is insufficient. It does not explain return format, parameter interactions, or how the 'context' is structured. The agent would lack critical information to use the tool correctly.

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?

Schema description coverage is 0%. The description mentions three input sources (mapper, SQL file, table) but does not map them to specific parameters (sql, filePath, table). Other parameters like line, maxTables, maxColumns, format, schema, profile are entirely unexplained, leaving the agent with no semantic guidance.

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 generates 'read-only table and column context' for three types of input: MyBatis mapper, SQL file, or explicit table. The verb 'generate' and the resource are specific, but it does not differentiate from similar sibling tools like ob_get_table_context or ob_describe_table.

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?

No guidance on when to use this tool versus alternatives. The context signals and sibling list show many related tools, but the description offers no criteria for selecting this tool, such as 'use for MyBatis mapper context specifically'.

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