create_glossary

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

The description only states that it creates a glossary, which is a write operation. It does not disclose any behavioral traits such as idempotency, side effects, required permissions, or error scenarios. Since no annotations are present, the description carries the full burden and falls short.

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. However, it saves space at the cost of essential detail. It is not verbose, but the brevity undermines its usefulness.

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 complexity of a nested object parameter and no output schema or annotations, the description is severely incomplete. The agent lacks necessary information to correctly invoke the tool, such as the structure of glossary_data or expected return values.

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?

The input schema has one required parameter 'glossary_data' of type object with 0% description coverage. The description does not explain what this parameter is, what properties it should contain, or provide any structural hints. The agent is left with no understanding of how to populate the parameter.

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 action (create) and resource (glossary) in the context of OpenMetadata. It is specific enough to distinguish from update_glossary or delete_glossary, but lacks any nuanced detail about what the glossary creation entails.

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 is provided on when to use this tool versus alternatives like update_glossary or other create_* tools. There is no mention of prerequisites, appropriate contexts, or when not to use it.

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