subscribe_topic

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It successfully reveals key traits: authentication requirement ('REQUIRES AUTHENTICATION'), mutation nature (implied by 'Set'), and return format ('Returns a SubscriptionResult with...'). However, it doesn't mention potential side effects like rate limits or whether this affects other users' notifications.

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 well-structured and front-loaded: purpose first, then authentication requirement, followed by parameter details, prerequisites, return values, and usage examples. Every sentence serves a distinct purpose with zero wasted text. The bulleted lists improve readability without adding fluff.

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?

Given the tool's moderate complexity (2 parameters, authentication requirement), the description provides complete context. It covers purpose, authentication, parameters, prerequisites, return values, and usage scenarios. With an output schema present, it appropriately doesn't over-explain return values. This is comprehensive for a subscription management tool.

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 description coverage is 100%, so the schema already documents both parameters thoroughly. The description adds marginal value by restating the level enum meanings in a more readable format and emphasizing the default value context. This slightly enhances understanding beyond the schema's technical documentation.

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 starts with a clear verb+resource statement: 'Set your notification level for a topic.' It specifically distinguishes this tool from siblings like 'get_topic_info' or 'get_notifications' by focusing on subscription management rather than information retrieval. The purpose is immediately apparent and differentiated.

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 provides explicit usage guidance: 'Must call login() first' establishes a prerequisite, and the 'Use to:' section lists specific scenarios (watch topics, mute noisy topics, track contributions) with corresponding level values. This gives clear context for when to use this tool versus alternatives like 'get_notifications' for reading notifications.

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