Subscribe Client To Topic

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

Annotations already mark destructiveHint=true and readOnlyHint=false. The description adds a key behavioral detail: the device is unaware of the subscription and it will not be recreated after a clean-session reconnect, which clarifies the side-effect nature beyond the annotation flags.

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 consists of two concise sentences: the first states the operation, the second adds an important caveat. Every sentence earns its place with no redundancy.

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, combined with the rich schema and annotations, covers the essential behavioral nuance (device unaware, clean-session behavior). Since an output schema exists, return values need not be explained, making the description sufficiently complete.

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?

All three parameters (clientid, topic, qos) have descriptions in the schema, giving 100% coverage. The description adds no additional parameter semantics beyond the action, so a baseline score of 3 is appropriate.

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 'Add a subscription to a client on its behalf,' which is a specific verb+resource. This distinguishes it from the sibling 'emqx_client_unsubscribe' which does the reverse action.

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 context about the behavior (device unaware, clean-session reconnect) but does not explicitly state when to use this tool versus alternatives like emqx_client_unsubscribe or emqx_publish. The usage guidance is implied rather than direct.

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