Search Business Glossary

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

No annotations provided, so description bears full burden. It conveys a read-only search returning mappings, and hints at permission filtering via 'allowed', but does not disclose response format, pagination, or potential side effects. Adequate but not rich.

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?

Single sentence, front-loaded with verb and resource, no fluff. Could benefit from structured bullet points for parameters, but the compactness is acceptable for a simple search tool.

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 4 parameters (one required), no output schema, and no annotations, the description leaves many gaps: response format, pagination, meaning of 'allowed', role of 'profile'. Not complete enough for confident usage.

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 coverage is 0% with no descriptions in the input schema for any parameter. The description only mentions 'search' and 'mapped to schemas/tables/columns', which implies query and schema as filters but fails to explain limit, profile, or their behavior. Insufficient compensation for missing schema details.

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?

Description clearly states the action (search) and resource (business glossary terms), and specifies the mapping context to OceanBase schemas, tables, and columns. This distinguishes it from sibling tools like ob_search_catalog or ob_list_tables.

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. With 27 sibling tools, the lack of usage context or exclusions makes it hard for an agent to decide when to invoke this over others like ob_search_catalog or ob_get_table_schema.

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