Create Streaming API PushTopic

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

Annotations already indicate this is a non-readonly, idempotent, non-destructive operation. The description adds useful behavioral details: clients subscribe via CometD, and notifications are filtered by SOQL and operations. This goes beyond annotations without contradicting them.

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?

Three sentences, front-loaded with the main action, and every sentence adds value. No fluff or repetition of schema details.

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 8 parameters, 2 required, and no output schema, the description adequately covers the core behavior and configuration. It mentions the subscription path and configurable operations. The only gap is no mention of the response/return value, but for a create operation it is less critical.

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?

Input schema provides 100% parameter descriptions, so baseline is 3. The description adds conceptual meaning by explaining that the SOQL query filters records and the operations/fields control which notifications trigger, which helps understand the overall mechanism beyond individual 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?

The description explicitly states the verb ('Creates') and specific resource ('Streaming API PushTopic') with a clear purpose ('real-time record change notifications'). It is distinct from sibling tools, all of which create different Salesforce artifacts.

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 clear context for when to use this tool (when real-time notifications on record changes are needed) and describes the mechanism (CometD subscription). It does not name alternative tools, but the use case is specific enough to guide selection.

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