Generate Onboarding Documentation

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

No annotations are provided, so the description must disclose behavioral traits. It mentions 'bounded' and 'visible metadata' but doesn't explain what that means in practice (e.g., does it mutate data? require permissions?). Lacks details on output, limits, or side effects.

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 a single sentence, concise and front-loaded. However, it sacrifices detail for brevity, missing important context about parameters and behavior.

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?

Given the tool's 10 parameters, no output schema, no annotations, and many siblings, the description is severely incomplete. It does not define 'onboarding documentation', 'bounded', or how to use the various constraints, leaving the agent without adequate guidance.

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%, placing the burden on the description. The description only vaguely references 'metadata' and 'business glossary hints', which correspond to some parameters, but fails to explain title, format, maxTables, tablePattern, and others. No parameter semantics provided.

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 it generates onboarding documentation from OceanBase metadata and business glossary hints. The verb 'Generate' and resource 'onboarding documentation' are specific, but the phrase 'bounded' is vague. Among many ob_generate_* siblings, it distinguishes itself by focusing on onboarding, but overlap with ob_generate_data_dictionary or ob_generate_schema_doc is not addressed, so not a perfect 5.

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 explicit guidance on when to use or avoid this tool. The description implies it's for onboarding documentation, but doesn't compare to alternatives like ob_generate_schema_doc or ob_generate_table_doc. No exclusions or context provided.

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