update_schema

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

Description indicates mutation ('update') but provides no details on idempotency, partial update capability, required permissions, or error handling. With no annotations, more behavioral context is needed.

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?

Description is a single sentence, concise and front-loaded, but may be too brief for the tool's complexity. It earns its place but lacks structure.

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?

No output schema provided and description does not explain return values, constraints, or error states. For a tool with an object parameter, more detail is expected.

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?

Input schema has two required parameters (schema_id, schema_data) with no descriptions. The description adds no meaning beyond the schema itself, and with 0% schema coverage, this is a significant gap.

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 verb 'update' and resource 'database schema' in OpenMetadata, distinguishing it from create, delete, and get schema tools. However, it could be more specific about what aspects of the schema can be updated.

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 like create_schema or delete_schema. Implied usage is when updating an existing schema, but no explicit when-not or context provided.

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