Configure Change Data Capture

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

Annotations already indicate mutation and idempotency. The description adds meaningful behavioral context: CDC publishes change events to /data/ChangeEvents for create, update, delete, and undelete operations, and the tool works via the Metadata API. It does not discuss permissions or deployment side effects, but the added information goes beyond the annotations.

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 concise sentences with no filler. The main action is front-loaded, and every sentence provides distinct, relevant information.

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 one-parameter enablement tool, the description covers purpose, mechanism, input format, and supported object types. It lacks explicit return/verification behavior and prerequisites, but these are not critical given the simple interface and available annotations.

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 already fully describes the single array parameter with examples, so the baseline is 3. The description reinforces that the array contains object API names and adds useful semantic context by stating standard and custom objects are supported, exceeding the schema's coverage.

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 clearly states the tool enables Change Data Capture for specified Salesforce objects via the Metadata API, naming the verb, resource, and mechanism. It also mentions the resulting change events channel, distinguishing it from sibling metadata 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 gives practical instruction to provide an array of object API names and notes that standard and custom objects are supported. However, it does not explicitly contrast this tool with alternatives or state when not to use it, leaving usage guidance mostly implied.

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