Create Custom Button or Link

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

Annotations already indicate this is a mutating, idempotent operation. The description adds context about the Metadata API mechanism and configurable target behaviors (sidebar, new window, etc.), which goes beyond what annotations convey, though it does not describe deployment side effects or return values.

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 three sentences long, front-loaded with the core action and resource, and each sentence adds distinct supporting detail with no repetition or filler.

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?

The description plus the rich schema provide a good baseline, but it omits potentially important operational nuances such as whether the button must be manually added to a page layout and how deployment outcomes are reported. Given the tool's complexity and lack of an output schema, this leaves some gaps.

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 covers all 7 parameters with descriptions and enums, so the description adds little new semantic detail. It only loosely restates the meaning of contentSource and openType, aligning with the baseline expected when schema coverage is 100%.

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 states a specific verb ('Creates') and a specific resource ('custom button or link on a Salesforce object via the Metadata API (WebLink)'), and it enumerates supported button types and content sources, making it clearly distinct from sibling creation tools.

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 conveys when to use the tool by listing supported button types (list, detail, mass action) and content sources (URL, JavaScript, Visualforce), but it does not explicitly mention alternatives or situations where another tool should be preferred.

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