SocialDataX 小红书 Xiaohongshu XHS RedNote MCP
Server Details
小红书/Xiaohongshu/XHS/RedNote note search, hot list, details, comments/replies, creator profiles.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
Glama MCP Gateway
Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.
Full call logging
Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.
Tool access control
Enable or disable individual tools per connector, so you decide what your agents can and cannot do.
Managed credentials
Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.
Usage analytics
See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.
Tool Definition Quality
Average 4.2/5 across 11 of 11 tools scored. Lowest: 3.6/5.
Each tool has a clearly distinct purpose, with pairs differentiated by input type (id vs url). All operations are well-separated: note detail, comments (first and sub-comments), user info, user posts, search, and hot list.
All tools follow the consistent pattern 'xhs_{action}_{resource}_by_{param}' (e.g., xhs_get_note_detail_by_note_id). Slight variation like 'xhs_search_notes' and 'xhs_get_search_hot_list' still align with the overall verb-noun structure.
With 11 tools, the server covers the core read operations for the Xiaohongshu platform without being overly broad or sparse. Each tool serves a necessary function for data retrieval.
The tool set adequately covers note details, comments (first and second level), user information, user posts, and search. Missing write operations are acceptable given the server's likely read-only purpose, but a few potential gaps exist (e.g., retrieving user followers or note likes).
Available Tools
14 toolsxhs_get_note_comments_by_note_idARead-onlyInspect
根据 note_id 获取单篇小红书笔记的一级评论。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 | |
| page_token | No | 分页令牌。首次请求留空;继续翻页时必须将上一页返回的完整 next_page_token 原样作为 page_token 传回。page_token 是不透明分页令牌,只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 当前页一级评论列表 |
| comment_count | Yes | 整篇笔记的总评论数,含一级评论与回复;不是当前页 items 数量 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果。继续翻页时必须将返回的完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
| top_level_comment_count | Yes | 整篇笔记的一级评论总数,不含回复;不是当前页 items 数量;无法获取时为 null |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations (readOnlyHint, openWorldHint), description reveals opaque pagination token behavior: must be passed exactly, cannot be reused across different contexts. This adds valuable behavioral insight not captured in 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?
Purpose is front-loaded in one sentence, but the pagination token explanation is verbose and repetitive, listing multiple prohibitions. Could be more concise without losing clarity.
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 presence of output schema, description covers pagination thoroughly and clarifies it returns first-level comments. Minor gaps: no mention of authentication or rate limits, but annotations cover safety profile.
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?
With 100% schema coverage, baseline is 3. Description adds significant meaning: note_id is a 24-character lowercase hex stable ID that must be copied exactly; page_token must be passed verbatim from previous response. This exceeds the schema's own descriptions.
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?
Description clearly states the action ('获取', get) and resource ('单篇小红书笔记的一级评论', first-level comments of a single note). It distinguishes from sibling tools like xhs_get_note_comments_by_note_url and xhs_get_note_sub_comments_by_comment_id by specifying 'note_id' and '一级评论'.
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?
Description does not provide explicit guidance on when to use this tool versus siblings, nor does it mention prerequisites or context for usage. The alternative tools are implied by name but not addressed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_note_comments_by_note_urlARead-onlyInspect
根据笔记链接、短链接或分享文案获取单篇小红书笔记的一级评论。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| note_url | Yes | 小红书笔记链接、短链接或分享文案。支持以下形式:1) 小红书笔记长链接;2) xhslink.com 短链接;3) 包含上述任一链接的完整分享文案。 | |
| page_token | No | 分页令牌。首次请求留空;继续翻页时必须将上一页返回的完整 next_page_token 原样作为 page_token 传回。page_token 是不透明分页令牌,只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 当前页一级评论列表 |
| comment_count | Yes | 整篇笔记的总评论数,含一级评论与回复;不是当前页 items 数量 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果。继续翻页时必须将返回的完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
| top_level_comment_count | Yes | 整篇笔记的一级评论总数,不含回复;不是当前页 items 数量;无法获取时为 null |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint. The description adds detailed behavioral context about pagination token opacity, non-reusability, and strict handling rules, which 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 two sentences: first states purpose, second details pagination. It is front-loaded, efficient, and contains no superfluous content.
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 that an output schema exists (not shown), the description does not need to explain return values. It covers core functionality and pagination behavior. Minor gaps like error handling or prerequisites are acceptable given the openWorldHint annotation.
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 baseline is 3. The description does not add significant new parameter details beyond what is in the schema, but it reiterates the note_url forms and pagination behavior from the schema.
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 specifies the verb '获取' and resource '单篇小红书笔记的一级评论', clearly indicating it retrieves top-level comments for a single Xiaohongshu note via URL. It distinguishes from sibling tool 'xhs_get_note_comments_by_note_id' by explicitly using note URL as input.
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 pagination instructions and constraints on token usage, but does not directly mention when to use this tool over alternatives like 'xhs_get_note_comments_by_note_id'. The context is clear but exclusions or alternatives are not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_note_detail_by_note_idARead-onlyInspect
根据 note_id 获取单篇小红书笔记详情。 返回的 note_url 非 null 时,在任何使用场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得用 note_id 重新拼接链接;note_url 为 null 时不要用 note_id 合成公开链接。
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| title | Yes | 笔记标题 |
| video | Yes | 视频摘要信息;无可用视频摘要时为 null |
| author | Yes | 作者信息;详情页不返回小红书号 |
| content | Yes | 笔记正文 |
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 |
| note_url | Yes | note_url 是可打开笔记内容所需的完整 URL。任何使用该返回链接的场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得修改、截断、脱敏、规范化、重组,也不得用 note_id 重新拼接链接。无法提供可用链接时为 null;note_url 为 null 时不要用 note_id 合成公开链接。 |
| note_type | Yes | 笔记类型;当前公开值固定为 image 或 video |
| like_count | Yes | 点赞数 |
| topic_tags | Yes | 笔记详情中的话题标签;无话题时为空数组 |
| image_items | Yes | 图片结构化明细;每项都表示一张图片,Live 图会在对应项携带 live_photo 摘要 |
| ip_location | Yes | 笔记发布时的 IP 属地;没有 IP 属地时为空字符串 |
| share_count | Yes | 分享数 |
| update_time | Yes | 更新时间,秒级 Unix 时间戳;没有有效更新时间时为 null |
| publish_time | Yes | 发布时间,秒级 Unix 时间戳 |
| collect_count | Yes | 收藏数 |
| comment_count | Yes | 评论数 |
| cover_image_url | Yes | 统一封面图 |
| mentioned_users | Yes | 笔记正文中 @ 到的用户列表;无 @ 时为空数组 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so safety profile is covered. The description adds critical behavioral context about note_url handling, which goes beyond 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 two sentences: the first states purpose clearly, the second gives essential usage instructions. No wasted words.
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 single parameter with full schema description, annotations covering read-only and open-world hints, and an existing output schema (though not shown), the description adequately covers all necessary aspects for correct tool invocation.
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 input schema provides a very detailed description for the single parameter note_id. With 100% schema coverage, the description adds no additional parameter information beyond the schema.
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 verb (get), resource (note detail), and method (by note_id). It distinguishes from sibling tool xhs_get_note_detail_by_note_url which uses URL instead.
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 instructions on preserving the returned note_url and warns against reconstructing public links. It implies usage context but does not explicitly compare to alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_note_detail_by_note_urlARead-onlyInspect
根据笔记链接、短链接或分享文案获取单篇小红书笔记详情。 返回的 note_url 在任何使用场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得用 note_id 重新拼接链接;note_url 为 null 时不要用 note_id 合成公开链接。
| Name | Required | Description | Default |
|---|---|---|---|
| note_url | Yes | 小红书笔记链接、短链接或分享文案。支持以下形式:1) 小红书笔记长链接;2) xhslink.com 短链接;3) 包含上述任一链接的完整分享文案。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| title | Yes | 笔记标题 |
| video | Yes | 视频摘要信息;无可用视频摘要时为 null |
| author | Yes | 作者信息;详情页不返回小红书号 |
| content | Yes | 笔记正文 |
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 |
| note_url | Yes | note_url 是可打开笔记内容所需的完整 URL。任何使用该返回链接的场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得修改、截断、脱敏、规范化、重组,也不得用 note_id 重新拼接链接。无法提供可用链接时为 null;note_url 为 null 时不要用 note_id 合成公开链接。 |
| note_type | Yes | 笔记类型;当前公开值固定为 image 或 video |
| like_count | Yes | 点赞数 |
| topic_tags | Yes | 笔记详情中的话题标签;无话题时为空数组 |
| image_items | Yes | 图片结构化明细;每项都表示一张图片,Live 图会在对应项携带 live_photo 摘要 |
| ip_location | Yes | 笔记发布时的 IP 属地;没有 IP 属地时为空字符串 |
| share_count | Yes | 分享数 |
| update_time | Yes | 更新时间,秒级 Unix 时间戳;没有有效更新时间时为 null |
| publish_time | Yes | 发布时间,秒级 Unix 时间戳 |
| collect_count | Yes | 收藏数 |
| comment_count | Yes | 评论数 |
| cover_image_url | Yes | 统一封面图 |
| mentioned_users | Yes | 笔记正文中 @ 到的用户列表;无 @ 时为空数组 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate readOnlyHint=true and openWorldHint=true. The description adds behavioral context by emphasizing the importance of preserving the returned URL, including query parameters. No contradictions with 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?
Two sentences, front-loaded with purpose and followed by critical usage instruction. No unnecessary words, but could be slightly more structured.
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 an output schema present, the description need not explain return values. It covers input format and output handling. Simple tool with one parameter, so description is adequate.
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 already covers the parameter note_url's supported formats (links, short links, share texts). The description reinforces the preservation rule but does not add new meaning beyond the schema. Baseline 3 due to 100% schema 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?
Description clearly states the tool retrieves a single note's detail using the note URL, short link, or share text. It distinguishes itself from sibling tools like xhs_get_note_detail_by_note_id which use note_id instead.
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?
Description provides explicit guidelines: keep the returned note_url original, do not reconstruct with note_id, and when note_url is null do not synthesize a public link. This instructs the agent on correct output handling, though it doesn't explicitly state when to use this tool vs alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_note_sub_comments_by_comment_idARead-onlyInspect
根据 note_id 和一级评论 comment_id 获取二级评论。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 | |
| comment_id | Yes | 一级评论 ID。可直接传一级评论结果中的 comment_id | |
| page_token | No | 分页令牌。首次请求留空;继续翻页时必须将上一页返回的完整 next_page_token 原样作为 page_token 传回。page_token 是不透明分页令牌,只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 当前页二级评论列表 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果。继续翻页时必须将返回的完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description adds important details about the opaque pagination token's binding to user, note, and comment chain, and strict rules against modification, which enhances transparency.
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 with a clear purpose followed by essential pagination rules. While thorough, it is appropriately concise for the complexity involved.
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 has an output schema (not shown but indicated), the description covers the necessary behavioral aspects and pagination completely. No gaps for a retrieval tool with sub-comments.
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 coverage is 100%, but the description adds crucial constraints, such as not truncating note_id and proper token handling, which are not fully captured in the schema descriptions.
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 it gets secondary comments based on note_id and first-level comment_id, distinguishing it from sibling tools like xhs_get_note_comments_by_note_id which retrieves first-level comments.
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 explains when to use the tool (given note_id and comment_id) and provides detailed pagination instructions, including initial empty page_token and subsequent token passing. It implies alternatives implicitly through sibling tool names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_search_hot_listARead-onlyInspect
获取小红书搜索热榜。
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 搜索热榜条目列表 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as readOnlyHint=true and openWorldHint=true. The description adds no additional behavioral context (e.g., rate limits, data freshness). With annotations covering safety, a score of 3 is appropriate as it provides no extra value but does not contradict.
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 sentence, front-loaded with the action and resource. No unnecessary words or redundancy. Perfect conciseness.
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 tool is simple with no parameters and an output schema present. The description covers the essential purpose. Completeness is high given the low complexity and available structured fields.
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?
There are no parameters (schema coverage 100%). According to guidelines, 0 parameters earns a baseline of 4. The description adds no parameter information because none is needed.
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?
Description clearly states verb '获取' (get) and resource '小红书搜索热榜' (Xiaohongshu search hot list). It is specific and distinguishable from sibling tools like xhs_search_notes, which is for searching notes rather than fetching a predefined hot list.
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?
No guidance on when to use this tool versus alternatives like xhs_search_notes. The description only states what it does, without contextual usage hints or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_user_info_by_profile_urlARead-onlyInspect
根据主页链接、短链接或分享文案获取单个小红书用户信息。
| Name | Required | Description | Default |
|---|---|---|---|
| profile_url | Yes | 小红书主页链接、短链接或分享文案。支持以下形式:1) xiaohongshu.com/user/profile/... 主页长链;2) xhslink.com 短链接;3) 包含上述任一链接的完整分享文案。请传主页链接,不要传笔记链接。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| bio | Yes | 用户个人简介(biography);没有简介时为空字符串 |
| name | Yes | 用户名称 |
| red_id | Yes | 用户公开小红书号;没有小红书号时为空字符串 |
| user_id | Yes | 用户 user_id |
| verified | Yes | 是否已认证 |
| avatar_url | Yes | 用户头像链接;没有头像链接时为 null |
| ip_location | Yes | 用户 IP 属地;没有 IP 属地时为空字符串 |
| profile_url | Yes | 用户主页链接;没有主页链接时为 null |
| follower_count | Yes | 粉丝数 |
| following_count | Yes | 关注数 |
| posted_note_count | Yes | 已发布笔记数 |
| received_like_count | Yes | 用户内容累计收到的点赞数 |
| verification_category | Yes | 认证类目/行业类目;未认证或没有认证类目时为空字符串 |
| received_collect_count | Yes | 用户内容累计被收藏数 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the description adds minimal behavioral context. It does not contradict annotations and is accurate, but doesn't provide additional depth 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?
Single, well-structured sentence that efficiently communicates the tool's purpose and input requirements without extraneous words.
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 simplicity of the tool (single parameter, read-only operation), the description fully covers necessary information, including input constraints and format examples.
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 coverage is 100%, and the description enriches the parameter meaning by listing specific types of links (long, short, shared text) and includes usage examples, which goes beyond the schema's brief description.
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 user info from a profile URL, short link, or shared text. It distinguishes from sibling tools like xhs_get_user_info_by_user_id by specifying the input type (profile URL vs user ID).
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 guidance on supported input formats and explicitly advises not to pass note links. While it doesn't explicitly mention when not to use it, the context of sibling tools makes the alternative clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_user_info_by_user_idARead-onlyInspect
根据 user_id 获取单个小红书用户信息。
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 小红书用户 user_id。请直接复制搜索结果、笔记详情、用户信息或用户发帖列表返回的 user_id/author.user_id;如果只有主页链接,请使用 profile_url 入口;不要传小红书号、昵称或主页名称 |
Output Schema
| Name | Required | Description |
|---|---|---|
| bio | Yes | 用户个人简介(biography);没有简介时为空字符串 |
| name | Yes | 用户名称 |
| red_id | Yes | 用户公开小红书号;没有小红书号时为空字符串 |
| user_id | Yes | 用户 user_id |
| verified | Yes | 是否已认证 |
| avatar_url | Yes | 用户头像链接;没有头像链接时为 null |
| ip_location | Yes | 用户 IP 属地;没有 IP 属地时为空字符串 |
| profile_url | Yes | 用户主页链接;没有主页链接时为 null |
| follower_count | Yes | 粉丝数 |
| following_count | Yes | 关注数 |
| posted_note_count | Yes | 已发布笔记数 |
| received_like_count | Yes | 用户内容累计收到的点赞数 |
| verification_category | Yes | 认证类目/行业类目;未认证或没有认证类目时为空字符串 |
| received_collect_count | Yes | 用户内容累计被收藏数 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description is consistent with annotations (readOnlyHint=true), indicating a read-only operation. However, it does not disclose any additional behavioral traits beyond what the annotations provide, such as rate limits or data freshness. The annotation coverage is high, so a baseline score of 3 is appropriate.
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, short sentence that directly states the purpose. It is front-loaded and free of fluff. However, it could be slightly expanded to include a quick usage hint, but for a simple tool this is efficient.
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 is brief but sufficient for a straightforward tool like this. With annotations and a detailed schema, the description does not need to explain return values. Yet, it could mention that this tool is suitable for batch processing or single lookups, but overall it is adequate.
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 input schema coverage is 100%, and the parameter description in the schema is very detailed, specifying correct usage and exclusions. The tool description adds no extra semantic information beyond the schema, warranting the baseline score.
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 action ('get') and resource ('user info'), specifying the key identifier ('by user_id'). It effectively distinguishes from sibling tools like xhs_get_user_info_by_profile_url, which uses a different identifier.
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?
While the parameter description hints when not to use this tool (e.g., avoid profile URLs), the main description lacks explicit guidance on when to use this tool versus its siblings. The context is implied but not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_user_posted_notes_by_profile_urlARead-onlyInspect
根据主页链接、短链接或分享文案获取用户已发布笔记列表。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| page_token | No | 分页令牌。首次请求留空;继续翻页时必须将上一页返回的完整 next_page_token 原样作为 page_token 传回。page_token 是不透明分页令牌,只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 | |
| profile_url | Yes | 小红书主页链接、短链接或分享文案。支持以下形式:1) xiaohongshu.com/user/profile/... 主页长链;2) xhslink.com 短链接;3) 包含上述任一链接的完整分享文案。请传主页链接,不要传笔记链接。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 当前页用户发帖摘要列表 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果。继续翻页时必须将返回的完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only and open world behavior. The description adds critical behavioral context about page_token being opaque, bound to the specific user/note/comment chain, and the strict prohibition on modification, which goes beyond 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 concise with two sentences: the first states the main purpose, the second gives essential pagination instructions. No unnecessary words, and the key information is front-loaded.
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 output schema exists, the description covers input, pagination, and token handling. It lacks mention of error cases or empty results, but the core usage is well explained.
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?
Although schema coverage is 100% with descriptions, the tool description adds extra nuance: profile_url supports various formats and page_token must not be altered. This adds meaning beyond the schema descriptions.
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 it gets posted notes by profile URL, short link, or share text, distinguishing it from sibling tools like xhs_get_user_posted_notes_by_user_id which uses user ID.
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 explains when to use this tool (to retrieve posted notes from a profile link) and provides detailed pagination instructions. However, it does not explicitly mention when not to use it or compare with alternatives like the user ID variant.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_user_posted_notes_by_user_idARead-onlyInspect
根据 user_id 获取用户已发布笔记列表。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | 小红书用户 user_id。请直接复制搜索结果、笔记详情、用户信息或用户发帖列表返回的 user_id/author.user_id;如果只有主页链接,请使用 profile_url 入口;不要传小红书号、昵称或主页名称 | |
| page_token | No | 分页令牌。首次请求留空;继续翻页时必须将上一页返回的完整 next_page_token 原样作为 page_token 传回。page_token 是不透明分页令牌,只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 当前页用户发帖摘要列表 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果。继续翻页时必须将返回的完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记或评论链路,不能跨用户、笔记或评论链路复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint and openWorldHint, already conveying safe read behavior. The description adds critical detail about the opaque pagination token's binding and immutability, enhancing transparency beyond 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?
Two sentences: first states purpose clearly, second covers the essential pagination rule. No extraneous information, front-loaded and efficient.
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 an output schema present, the description only needs to explain behavior beyond return values. It covers the purpose and the critical pagination constraint, sufficient for a simple list retrieval 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 coverage is 100% with detailed parameter descriptions. The tool description largely repeats the pagination token behavior already documented in the schema, adding no new semantic meaning for the parameters.
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 tool retrieves a user's posted notes by user_id, with a specific verb and resource. It distinguishes from the sibling tool xhs_get_user_posted_notes_by_profile_url by the input method (user_id vs profile URL).
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 user_id parameter description advises to use profile_url if only a profile link is available, explicitly directing to the sibling tool. This provides clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_get_video_speech_text_jobARead-onlyInspect
查询小红书视频口播转文字任务状态;只查询当前 job,不触发重处理或长等待。
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | 口播转文字任务 ID。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | Yes | 失败或过期时的稳定错误结构;非终态或成功时为 null。 |
| job_id | Yes | 任务 ID。 |
| status | Yes | 任务状态。 |
| message | Yes | 面向用户/AI 的状态说明。 |
| platform | Yes | 任务所属平台。 |
| source_id | Yes | 任务来源 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_type | Yes | 内容类型。 |
| next_poll_after_seconds | Yes | 建议下次查询前等待的秒数;非终态时可用。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations provide readOnlyHint and openWorldHint. The description adds that it does not trigger reprocessing or long waits, which is a useful behavioral detail 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 a single sentence that efficiently conveys the purpose and key constraints with no superfluous words.
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 simple single-parameter input and the existence of an output schema, the description adequately covers the tool's behavior and purpose. It could hint at response structure but the output schema handles that.
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%, with the parameter job_id described as '口播转文字任务 ID'. The description adds no additional parameter details, so baseline 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 states '查询小红书视频口播转文字任务状态' (query job status), specifying the verb and resource. It distinguishes from siblings by clarifying it only queries current jobs and does not trigger reprocessing.
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 explicitly states it only queries current jobs and does not trigger reprocessing or long waits, implying that for triggering, other tools like the submit variants should be used. However, it doesn't explicitly name alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_search_notesARead-onlyInspect
按关键词搜索相关小红书笔记。 返回的 note_url 在任何使用场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得用 note_id 重新拼接链接。
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 搜索结果页码,从 1 开始;继续获取更多结果时使用相同 keyword、sort_type、note_type 和 publish_time_range,并将 page 设为上一次返回的 next_page;items 为空且 next_page 为 null 表示没有下一页 | |
| keyword | Yes | 小红书搜索关键词 | |
| note_type | No | 笔记类型筛选,可选:all(不限,默认)、image(图文)、video(视频) | all |
| sort_type | No | 搜索结果排序方式,可选:general(综合,默认)、time_descending(最新发布优先)、like_count_descending(最多点赞优先)、comment_count_descending(最多评论优先)、collect_count_descending(最多收藏优先) | general |
| publish_time_range | No | 发布时间范围筛选,可选:all(不限,默认)、day(一天内)、week(一周内)、half_year(半年内) | all |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 搜索结果中的笔记列表,已过滤非笔记卡片与不可公开笔记;当前页过滤后可能为空数组 |
| next_page | Yes | 下一次可尝试请求的搜索页码;仅当 next_page 为 null 时表示没有下一页;非空时表示继续搜索应传入的 page,items 为空时不要单独据此判断结束 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as readOnlyHint=true and openWorldHint=true. The description adds behavioral context about the response format: the note_url must be kept intact with all query parameters. This goes beyond annotations by specifying a critical output behavior, though it does not elaborate on other response fields (handled by output schema).
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 extremely concise: two sentences. The first sentence states the purpose, and the second delivers a crucial instruction. No extraneous words, every sentence adds value. Front-loaded with the primary action.
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 tool has an output schema (context indicates true), so return value details are not required. The description covers the key behavioral constraint (note_url preservation). It does not mention pagination or filtering, but these are fully documented in the input schema. Overall, it is complete for the tool's role.
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 input schema has 100% description coverage with clear parameter descriptions, enums, and defaults. The tool description adds no new information about parameters beyond stating the keyword search purpose. Given high schema coverage, baseline 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 the tool's purpose: '按关键词搜索相关小红书笔记' (search related notes by keyword). It also specifies a critical output handling rule, distinguishing it from sibling tools like note detail or user info retrieval. The verb '搜索' (search) and resource '笔记' (notes) are specific and unambiguous.
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 implicitly indicates when to use the tool (keyword search) but does not explicitly contrast with sibling tools. However, it provides a clear usage rule: preserve the full note_url including xsec_token. This guidance helps the agent use the tool correctly but lacks explicit exclusion of other use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_submit_video_speech_text_by_note_idAInspect
根据小红书 note_id 提交视频笔记口播转文字任务;提交完成后最多短等 15 秒,未完成时返回 job_id 和下一步查询动作。
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | Yes | 失败或过期时的稳定错误结构;非终态或成功时为 null。 |
| job_id | Yes | 任务 ID。 |
| status | Yes | 任务状态。 |
| message | Yes | 面向用户/AI 的状态说明。 |
| platform | Yes | 任务所属平台。 |
| source_id | Yes | 任务来源 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_type | Yes | 内容类型。 |
| next_poll_after_seconds | Yes | 建议下次查询前等待的秒数;非终态时可用。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description reveals asynchronous behavior: wait up to 15 seconds, if incomplete return job_id and next query action. No annotations provided, but description sufficiently covers key behavioral traits.
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?
A single sentence that efficiently conveys purpose, async nature, wait time, and result behavior. No wasted words.
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 one well-described parameter and output schema existence, the description is sufficient. It covers task submission and expected result, though it could mention the output schema minimally.
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 coverage is 100% with detailed note_id description. The tool description adds no extra parameter meaning beyond schema, so baseline 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 it submits a speech-to-text task for a video note using note_id, distinguishes from the sibling xhs_submit_video_speech_text_by_note_url which uses note_url.
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 implies usage when having note_id but does not explicitly state when to use this tool versus the URL-based sibling, nor does it provide when-not or alternative tool guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_submit_video_speech_text_by_note_urlAInspect
提交小红书视频笔记口播转文字任务;提交完成后最多短等 15 秒,未完成时返回 job_id 和下一步查询动作。
| Name | Required | Description | Default |
|---|---|---|---|
| note_url | Yes | 小红书视频笔记链接、短链接或分享文案。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | Yes | 失败或过期时的稳定错误结构;非终态或成功时为 null。 |
| job_id | Yes | 任务 ID。 |
| status | Yes | 任务状态。 |
| message | Yes | 面向用户/AI 的状态说明。 |
| platform | Yes | 任务所属平台。 |
| source_id | Yes | 任务来源 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_type | Yes | 内容类型。 |
| next_poll_after_seconds | Yes | 建议下次查询前等待的秒数;非终态时可用。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the asynchronous behavior (wait 15s, return job_id if incomplete) and hints at next steps. It does not cover authentication or rate limits, but for a submit task this is sufficient.
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 two short sentences that immediately state the action and the key behavior (wait and return job_id). No redundant 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?
Given the tool has one parameter and an output schema, the description covers submission, the async nature, and what to expect. It is complete for a submit-oriented 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?
The single parameter 'note_url' is fully described in the schema (link, short link, or share text). The description adds no additional meaning beyond the schema, so baseline scoring applies.
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 action (submit a speech-to-text task) and the resource (XiaoHongShu video note). The name includes 'by_note_url' which distinguishes it from the sibling tool 'xhs_submit_video_speech_text_by_note_id' that uses note ID instead.
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 usage context: submit the task, wait up to 15 seconds, and if not completed, get a job_id for subsequent queries. It implies the tool is for URL-based notes but does not explicitly contrast with the note_id variant or mention when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [{ "email": "your-email@example.com" }]
}The email address must match the email associated with your Glama account. Once published, Glama will automatically detect and verify the file within a few minutes.
Control your server's listing on Glama, including description and metadata
Access analytics and receive server usage reports
Get monitoring and health status updates for your server
Feature your server to boost visibility and reach more users
For users:
Full audit trail – every tool call is logged with inputs and outputs for compliance and debugging
Granular tool control – enable or disable individual tools per connector to limit what your AI agents can do
Centralized credential management – store and rotate API keys and OAuth tokens in one place
Change alerts – get notified when a connector changes its schema, adds or removes tools, or updates tool definitions, so nothing breaks silently
For server owners:
Proven adoption – public usage metrics on your listing show real-world traction and build trust with prospective users
Tool-level analytics – see which tools are being used most, helping you prioritize development and documentation
Direct user feedback – users can report issues and suggest improvements through the listing, giving you a channel you would not have otherwise
The connector status is unhealthy when Glama is unable to successfully connect to the server. This can happen for several reasons:
The server is experiencing an outage
The URL of the server is wrong
Credentials required to access the server are missing or invalid
If you are the owner of this MCP connector and would like to make modifications to the listing, including providing test credentials for accessing the server, please contact support@glama.ai.
Discussions
No comments yet. Be the first to start the discussion!