apex_describe_table

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering safety. The description adds the valuable behavioral detail 'Cached per session,' which is not available in annotations. This explains why repeated calls may return stale data without requiring force_refresh.

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 short sentence (7 words) that front-loads the core purpose and includes a useful behavioral note. No wasted words; every element earns its place.

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?

For a simple read-only describe tool with an output schema and comprehensive annotations, the description covers purpose and caching behavior. It does not explicitly mention output structure or validation, but the output schema fills that gap. It could mention that it is read-only (though annotations already do), so it is complete enough.

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 schema covers 100% of parameters with descriptions, so the baseline is 3. The description's 'Cached per session' adds context for force_refresh but is already implied by the schema's 'Bypass cache'. No additional parameter semantics are provided beyond the schema.

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 uses the specific verb 'Describe' and identifies the resource ('table') with explicit outputs ('columns, types, PKs, and FKs'). It clearly distinguishes from sibling tools like apex_list_tables (which likely lists tables) and apex_run_sql (general SQL execution).

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 implies use for inspecting table schema but provides no explicit guidance on when to choose this over alternatives. The phrase 'Cached per session' hints at repeated use, but no exclusions or alternative recommendations are given. It is clear in context but lacks explicit when/when-not guidance.

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