Generate Table Documentation

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

With no annotations, the description must disclose behavioral traits. It mentions 'bounded' and 'without returning sample values' but does not explain what 'bounded' means, whether the operation is read-only, or any permission requirements. The behavioral context is insufficient.

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 concise sentence that conveys key points: bounded, JSON/Markdown, one table, no sample values. It is efficient but could benefit from a bit more structure or additional sentences to improve 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?

Given the tool's complexity (10 parameters, no output schema, no annotations), the description is severely inadequate. It does not describe the output structure, parameter usage, constraints, or any contextual details needed for proper invocation.

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% for 10 parameters. The description only implicitly references the 'table' parameter and the output format, but fails to explain the purpose of other parameters like title, schema, profile, maxColumns, maxExamples, relationshipLimit, includeQueryExamples, and includeRelationships. The agent cannot correctly set these parameters without external knowledge.

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 JSON or Markdown documentation for a single visible table, and explicitly excludes sample values. This distinguishes it from sibling tools like ob_describe_table and ob_get_table_schema.

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 no guidance on when to use this tool over alternatives, such as ob_generate_schema_doc or ob_get_table_ddl. It does not mention scenarios, prerequisites, or decision factors like choosing between JSON and Markdown.

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