describe-sobject

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

The description mentions '1-hour caching' as a behavioral trait, but with no annotations, it fails to disclose whether the operation is read-only, has side effects, or any rate limits. The caching detail is helpful but insufficient for full transparency.

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 concise and front-loaded: it states the action and resource immediately, followed by the key behavioral detail. No wasted words.

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?

With no output schema, the description does not specify what metadata is returned (e.g., fields, relationships, labels). It is adequate for a simple tool but lacks completeness in explaining the scope and content of the description.

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 100% with both parameters described. The description adds value beyond the schema by specifying the caching duration (1-hour), which clarifies the behavior of the useCache parameter. This enhances understanding beyond the schema's generic description.

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 'Describe SObject metadata with 1-hour caching' clearly states the action (Describe) and resource (SObject metadata). The caching detail adds specificity, and the tool's purpose is distinct from sibling tools like create-record or execute-soql.

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 retrieve-metadata or list-metadata-types. The description does not provide context for selection, leaving the agent to infer from the name alone.

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