Get Database Dictionary

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

With no annotations, the description carries the full burden. It mentions 'bounded' and 'visible' metadata, implying scope and output format, but does not clarify output structure, whether it modifies data, or error states. It provides some behavioral context but is incomplete.

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, efficient sentence that front-loads the main purpose. It is concise, but a bit more structure (e.g., listing key parameters briefly) could improve clarity without losing efficiency.

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 6 optional parameters, no output schema, and no annotations, the description is insufficient. It does not explain output shape, constraints, or how to use parameters effectively. The tool's capabilities are only vaguely outlined.

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%, so the description must explain parameters. It only hints at format through 'JSON or Markdown' but does not detail 'schema', 'profile', 'maxTables', or others. The enum for 'format' is implicitly covered, but other parameters remain undefined.

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's purpose: generating a bounded JSON or Markdown data dictionary from visible table and column metadata. It uses specific verbs and resource nouns. However, it does not differentiate from the similar sibling tool 'ob_generate_data_dictionary', which may cause confusion.

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 versus alternatives, nor does it mention any prerequisites or exclusions. The sibling list is extensive, but the description lacks any contextual cues to help the agent decide.

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