get_note_detail

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

With no annotations, the description carries full burden. It discloses the need for login, the default comment limit, and the function of max_comments for pagination. It also reveals that xsec_token is obtained from search results, implying an interdependent workflow. It does not cover error cases or rate limits, but overall provides sufficient behavioral context.

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 a single, concise paragraph (60 characters) that front-loads the purpose, then prerequisites, then behavioral details. Every sentence adds value without 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?

Given the existence of an output schema, the description adequately covers what the tool does, required/optional inputs, prerequisite login, and comment pagination. It does not mention error conditions or missing xsec_token behavior, but overall provides enough context for an agent to use correctly.

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 has 0% description coverage, so description must compensate. It adds meaning: note_id is the note ID, xsec_token comes from search results, and max_comments controls comment depth with a default of 10. This is valuable beyond schema, especially for xsec_token which has no schema 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 clearly states the tool retrieves complete details of a Xiaohongshu note, specifying verb '获取' and resource '笔记详情', and lists content types (text, comments, images, interaction data). This distinguishes it from sibling tools like search or login functions.

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 prerequisites: login required (login_xiaohongshu) and that note_id/xsec_token come from search results. It also explains default comment count and how to get more. However, it does not explicitly state when not to use or list alternatives, though no direct alternatives exist among siblings.

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