generate_workflow_workbook

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

With no annotations, description carries full burden. It discloses that data is from a live instance, lists populated items, and notes one setting is preserved. However, it lacks safety info (e.g., read-only vs mutation), authentication needs beyond parameters, or rate limits.

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 concise with clear purpose first, then bullet-like list of populated items, and return object. Every sentence adds value, though no parameter info slightly reduces efficiency.

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?

Output schema exists and description matches return fields, but three parameters are completely undocumented. For a generation tool, parameter context is crucial; current level is adequate for output but insufficient for input.

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% and description provides no explanation for the three parameters (data_center, auth_user_id, auth_password). Description must compensate but fails to add any meaning beyond parameter names.

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 tool generates a workbook for Workflow Notifications & Messages from a live SF instance. Specifically lists populated sheets and distinguishes from sibling tools like generate_fo_workbook or generate_rules_workbook.

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?

Description implicitly indicates use for workflow workbook generation but does not provide explicit when-to-use or when-not-to-use guidance relative to 50+ sibling tools. No exclusions or alternatives mentioned.

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