SocialDataX 小红书 Xiaohongshu XHS RedNote MCP
Server Details
XHS note search, hot list, details, comments/replies, profiles, transcript.
- 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/5 across 14 of 14 tools scored. Lowest: 3.2/5.
Multiple tools exist in pairs distinguished only by input type (ID vs URL), such as get_note_comments and get_note_detail. While descriptions clarify the difference, an agent may still be uncertain which to use when both inputs are available, leading to potential misselection. However, most tools have distinct purposes (comments, user info, search, etc.).
All tools follow the 'xhs_' prefix and use a verb_noun pattern (e.g., get_note_comments, search_notes). There is minor inconsistency: 'get_search_hot_list' uses 'get' while 'search_notes' uses 'search' as the verb. Overall, the pattern is clear and predictable.
With 14 tools, the count is on the higher end but still within a reasonable range for a domain covering note details, comments, user info, search, and video speech text. The presence of ID/URL duplicate pairs inflates the count slightly, but each tool serves a clear purpose.
The tool surface covers core read operations (notes, comments, user info, search, hot list) and video speech transcription. However, missing operations like note statistics (likes, collections), user followers/following, or trending tags leave notable gaps for a comprehensive data extraction server.
Available Tools
14 toolsxhs_get_note_comments_by_note_idARead-onlyInspect
根据 note_id 获取单篇小红书笔记的一级评论,支持 sort_type 评论排序和 page_token 翻页。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记、排序或评论链路,不能跨用户、笔记或评论链路复用;一级评论还不能跨排序复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| note_id | Yes | note_id 是 24 位小写十六进制稳定笔记 ID。必须原样复制搜索、详情、评论或用户发帖列表返回的完整 note_id;不得截断、缩写、脱敏、补全、格式化、重组,也不得只传前缀。 | |
| sort_type | No | 评论排序方式,可选:default(默认/综合排序)、time_descending(最新评论优先)、like_count_descending(点赞最多优先) | default |
| 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 declare readOnlyHint and openWorldHint. The description adds critical behavioral details: pagination token is opaque, context-bound, and must be passed unchanged. This 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 relatively concise, front-loads the main purpose, and then details pagination rules. Each sentence adds value; length is appropriate for the complexity.
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 an output schema exists, the description does not need return details. It covers pagination, sorting, and token constraints. It clearly identifies '一级评论' (top-level comments), leaving no gaps.
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%. The description reinforces constraints on note_id (24-char hex) and page_token (opaque, no modification), adding value beyond 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 the tool gets top-level comments for a note by note_id. It distinguishes from siblings implicitly (e.g., sub-comments tool exists), but does not explicitly mention when to use this over others.
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 how to use pagination and sorting, but does not provide explicit guidance on when to use this tool vs. alternatives, such as note detail or sub-comment tools.
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
根据笔记链接、短链接或分享文案获取单篇小红书笔记的一级评论,支持 sort_type 评论排序和 page_token 翻页。 返回的 next_page_token 是不透明分页令牌;继续翻页时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只绑定当前用户、笔记、排序或评论链路,不能跨用户、笔记或评论链路复用;一级评论还不能跨排序复用;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成,不得用省略号替换中间内容。
| Name | Required | Description | Default |
|---|---|---|---|
| note_url | Yes | 小红书笔记链接、短链接或分享文案。支持以下形式:1) 小红书笔记长链接;2) xhslink.com / xhslink.cn / xhsurl.com / xhsurl.cn 短链接;3) 包含上述任一链接的完整分享文案。 | |
| sort_type | No | 评论排序方式,可选:default(默认/综合排序)、time_descending(最新评论优先)、like_count_descending(点赞最多优先) | default |
| 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?
The description provides extensive behavioral details beyond annotations: it explains the opaque pagination token, its binding constraints (user, note, sort), and strict usage rules (no modification). Annotations already declare readOnlyHint and openWorldHint, but the description adds critical token management specifics.
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 efficiently written with no wasted words, but it could be structured into clearer sentences for readability. The main purpose is front-loaded, and every sentence adds value, though the long token handling section could be condensed.
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 complexity (pagination, sorting, token restrictions) and the presence of an output schema (not shown), the description adequately covers input format, token behavior, and sorting options. It does not cover error handling or rate limits, but the overall context is sufficient for reliable 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?
With 100% schema description coverage, the baseline is 3. The description does not add significant new parameter-level information beyond what the schema already provides; it repeats token handling but primarily in narrative form. No additional parameter context is offered.
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 first-level comments from a single Xiaohongshu note via URL, short link, or share text. This distinguishes it from sibling tools like xhs_get_note_detail_by_note_url and xhs_get_note_sub_comments_by_comment_id by specifying the exact resource (comments) and level (first-level).
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 suggests usage for fetching first-level comments with sorting and pagination, but it does not explicitly differentiate from alternatives like xhs_get_note_comments_by_note_id (by note ID). It lacks when-to-use or when-not-to-use guidance relative to sibling tools.
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 indicate read-only and open-world behavior. The description adds important behavioral context about URL handling, which goes beyond annotations and reduces ambiguity.
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 concise sentences with the primary purpose front-loaded. Every sentence adds essential information, with 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?
For a simple read-only tool with one parameter, the description is reasonably complete. The output schema likely covers the return format, so the description need not duplicate 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%, so the baseline is 3. The description does not add additional parameter meaning beyond what is already in 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 that the tool gets note details by note_id. However, it does not explicitly distinguish this from the sibling tool xhs_get_note_detail_by_note_url, missing a chance to clarify when to use which.
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 critical usage guidance about preserving the note_url when non-null and avoiding synthetic links when null. However, it does not explain when to prefer this tool over the URL-based alternative.
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 / xhslink.cn / xhsurl.com / xhsurl.cn 短链接;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?
The description adds significant behavioral context beyond annotations: it mandates preserving the full returned note_url (including xsec_token) and prohibits synthesizing a public link when note_url is null. This is consistent with readOnlyHint and openWorldHint 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 concise sentences: first defines the function, second provides critical handling instructions. No wasted words, 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 presence of an output schema, the description adequately covers the tool's purpose and important output constraints. It lacks explicit mention of prerequisites or limitations, but is sufficient 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 coverage is 100% and the schema already describes the parameter format. The description adds no additional meaning about the parameter itself, only output handling instructions.
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 note details from a note URL, short link, or sharing text. This distinguishes it from sibling 'xhs_get_note_detail_by_note_id' which uses a note ID, providing specific verb and resource.
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 using this tool (when you have a URL/link), but does not explicitly state when not to use it or mention the alternative by note_id. However, the sibling list implies the differentiation.
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?
Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds critical behavioral details about pagination: the next_page_token is opaque, bound to the current user/note/comment, and must be used exactly as returned without modification. This goes well 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: purpose first, then pagination instructions. It is front-loaded and no word is wasted. The pagination sentence is long but necessary and clear; it could be split for readability but is still 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, return value documentation is not needed. The description covers the key behaviors (pagination rules) and resource constraints. It does not mention error handling or auth, but annotations partially cover safety. Overall sufficient for a paginated list 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?
Input schema has 100% description coverage with detailed rules for note_id and page_token. The tool description does not add further parameter meaning; it only contextualizes pagination behavior. Baseline 3 is appropriate since schema carries the semantic load.
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 opens with '根据 note_id 和一级评论 comment_id 获取二级评论,' clearly specifying the action (get) and resources (note_id, comment_id) for sub-comments. This directly distinguishes it from sibling tools like xhs_get_note_comments_by_note_id which fetch top-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 purpose implies usage: when you have a note_id and a top-level comment_id, use this tool. No explicit when-not or alternatives provided, but the sibling tools cover different scopes (search, details, user info), so selection is straightforward.
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 declare readOnlyHint and openWorldHint. Description adds no additional behavioral context 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 short sentence, no waste. However, it lacks any structure or additional details that could help.
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 zero parameters, existing output schema, and annotations, the description is minimally sufficient. Could mention that it requires no input.
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 zero parameters and 100% coverage. Description does not add parameter info, but 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 (小红书搜索热榜/search hot list of Xiaohongshu). It is distinct from sibling tools which deal with notes, comments, and user data.
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. Description lacks context on scenarios 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 / xhslink.cn / xhsurl.com / xhsurl.cn 短链接;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 |
| profile_tags | Yes | 主页头部标签名称列表;没有标签时为空数组 |
| follower_count | Yes | 粉丝数 |
| following_count | Yes | 关注数 |
| posted_note_count | Yes | 已发布笔记数 |
| verification_name | Yes | 认证主体名称;没有认证主体时为空字符串 |
| received_like_count | Yes | 用户内容累计收到的点赞数 |
| is_enterprise_account | Yes | 是否为企业账号 |
| verification_category | Yes | 认证补充信息;可能是行业类目或认证主体名称;未认证或没有认证信息时为空字符串 |
| received_collect_count | Yes | 用户内容累计被收藏数 |
| is_professional_account | Yes | 是否为专业号 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds context about supported input formats (homepage link, short link, share copy) but no behavioral traits beyond that, and is consistent 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?
The description is a single sentence that is concise, front-loaded, and contains no unnecessary 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), existing output schema, and annotations, the description fully covers the necessary context for an agent to use the tool 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 coverage is 100% with a detailed description of the profile_url parameter. The description's mention of input types mirrors the schema, adding no additional meaning beyond what the schema already provides.
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 (单个小红书用户信息/single Xiaohongshu user info), and input types (主页链接、短链接或分享文案/profile link, short link, or share copy), distinguishing it from sibling tools like xhs_get_user_info_by_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 implies usage when a profile URL is available but does not explicitly state when to use this tool versus alternatives like xhs_get_user_info_by_user_id or provide when-not context.
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 |
| profile_tags | Yes | 主页头部标签名称列表;没有标签时为空数组 |
| follower_count | Yes | 粉丝数 |
| following_count | Yes | 关注数 |
| posted_note_count | Yes | 已发布笔记数 |
| verification_name | Yes | 认证主体名称;没有认证主体时为空字符串 |
| received_like_count | Yes | 用户内容累计收到的点赞数 |
| is_enterprise_account | Yes | 是否为企业账号 |
| verification_category | Yes | 认证补充信息;可能是行业类目或认证主体名称;未认证或没有认证信息时为空字符串 |
| received_collect_count | Yes | 用户内容累计被收藏数 |
| is_professional_account | Yes | 是否为专业号 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the tool is clearly a safe read operation. The description does not add behavioral details beyond what annotations provide, such as response format or rate limits, but also does not contradict 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, efficient sentence with no wasted words. It is appropriately front-loaded. However, it could benefit from a brief note on the return format, though the output schema covers that.
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 simplicity (one required parameter, read-only operation), the description plus detailed parameter guidance and annotations are sufficient. The existence of an output schema means return values are documented elsewhere.
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% for the single parameter, providing detailed guidance on what values to use. The main description does not add extra meaning beyond the schema, 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 the action ('获取') and the resource ('单个小红书用户信息'), and the method ('by user_id'). It 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 main description lacks explicit usage guidance, the parameter description for 'user_id' provides clear instructions on when to use this tool (when you have a user_id) and directs to the alternative profile_url tool when only a homepage link is available.
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 / xhslink.cn / xhsurl.com / xhsurl.cn 短链接;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?
The description adds significant behavioral context beyond the annotations, detailing the opaque nature of next_page_token, its strict non-reusability across different entities, and explicit rules against modification. This fully informs the agent of the tool's constraints and operation.
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 purpose, and the second provides critical pagination token rules. Every sentence is necessary and front-loaded, with 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 presence of an output schema, the description adequately covers pagination complexity and token constraints without needing to detail return values. It is complete for a list tool with this level of complexity.
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 description coverage, the schema already documents both parameters. However, the description adds meaningful extra details for profile_url (supported formats, instruction to use profile link not note link) and reinforces page_token rules, providing semantic value 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 tool gets a list of posted notes from a user profile using a profile URL, short link, or share text. This distinguishes it from sibling tools like xhs_get_user_posted_notes_by_user_id, which uses a user ID, making the purpose 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 provides implicit guidance (e.g., '请传主页链接,不要传笔记链接') but does not explicitly state when to use this tool versus alternatives like xhs_get_user_posted_notes_by_user_id. No exclusions or when-not-to-use context is given, limiting its helpfulness for tool selection.
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 provide readOnlyHint=true and openWorldHint=true, indicating a safe read operation that may return unexpected properties. The description adds behavioral context beyond annotations, such as the token being opaque and bound to the current query, which informs the agent about handling pagination.
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: one sentence for the core purpose, followed by necessary token handling details. Every sentence adds value, and the structure is 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?
Given the tool's complexity (two parameters) and the presence of annotations and output schema, the description covers all necessary behavioral aspects, including token binding and handling. No missing information for correct 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?
Schema description coverage is 100%, so baseline is 3. The description adds significant meaning: for user_id, it specifies not to use other identifiers (like xiaohongshu ID, nickname) and to copy from certain sources; for page_token, it describes how to use it correctly and what not to do, going beyond the schema's 'opaque' 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's function: '根据 user_id 获取用户已发布笔记列表' (get user's published notes list by user_id). It distinguishes itself from sibling tools like xhs_get_user_posted_notes_by_profile_url by specifying the user_id parameter, and provides additional context about the pagination token.
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 does not explicitly state when to use this tool versus alternatives (e.g., when user_id is available vs. profile_url), but the naming convention implies usage when user_id is known. The detailed pagination token instructions serve as usage guidance for that specific aspect.
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。 | |
| wait_seconds | No | 可选长轮询等待秒数;0 表示只查询一次,最大 240 秒。 |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | Yes | 失败或过期时的稳定错误结构;非终态或成功时为 null。 |
| job_id | Yes | 任务 ID。 |
| status | Yes | 任务状态。 |
| message | Yes | 面向用户/AI 的状态说明。 |
| platform | Yes | 任务所属平台。 |
| source_id | Yes | 任务来源 ID。 |
| content_id | Yes | 平台内容 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_meta | 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 already declare readOnlyHint and openWorldHint. The description adds that long-polling is optional and that the tool does not trigger reprocessing, providing behavioral context 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, dense sentence in Chinese with no wasted words. It is front-loaded with the core purpose.
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 the tool's function and the optional long-poll behavior. It does not explain error conditions or rate limits, but for a simple read-only status check with good annotations, this is sufficient.
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 both parameters described. The description mentions long-polling, but the schema already states '可选长轮询等待秒数'. No additional meaning 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 tool queries video speech-to-text job status, including optional long-polling and that it does not trigger reprocessing. This specific verb+resource combination distinguishes it from sibling submit tools.
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 for checking status of a submitted job, and distinguishes from submit tools by stating '不触发重处理' (does not trigger reprocessing). However, it does not explicitly state when not to use it or provide alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
xhs_search_notesBRead-onlyInspect
按关键词搜索相关小红书笔记。 返回的 note_url 在任何使用场景都必须原样保留完整 URL,包括 xsec_token 等 query 参数;例如最终回答、展示、引用、存储、输出或传递;不得用 note_id 重新拼接链接。
| Name | Required | Description | Default |
|---|---|---|---|
| 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 |
| page_token | No | 搜索分页令牌。首次请求留空;继续翻页时传入上一页返回的 完整 next_page_token 原样作为 page_token 传回。page_token 只能用于同一关键词、排序、笔记类型、发布时间范围和调用方的搜索链路;不得修改、截断、缩写、脱敏、掩码、省略、规范化、重组或自行生成。 | |
| publish_time_range | No | 发布时间范围筛选,可选:all(不限,默认)、day(一天内)、week(一周内)、half_year(半年内) | all |
Output Schema
| Name | Required | Description |
|---|---|---|
| items | Yes | 搜索结果中的笔记列表,已过滤非笔记卡片与不可公开笔记;当前页过滤后可能为空数组 |
| next_page_token | Yes | 下一页不透明分页令牌;为空表示没有更多结果或无法继续 token 翻页。继续搜索时必须将完整 next_page_token 原样作为 page_token 传回。next_page_token 只能用于同一关键词、排序、笔记类型、发布时间范围和调用方的搜索链路。items 为空时不要单独据此判断结束。 |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses a critical behavioral rule: the returned note_url must be kept intact. This adds value beyond the readOnlyHint annotation. However, it lacks details on pagination, result limits, or behavior of sort/type parameters beyond schema descriptions.
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 short (two sentences) and front-loads the purpose. The second sentence is somewhat long but conveys important information. Could be slightly more structured (e.g., separate output handling), but overall 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?
Given the tool's complexity (5 parameters, pagination, sorting) and presence of an output schema, the description covers the basic purpose and a key output handling rule. However, it omits context about pagination, the meaning of openWorldHint, and how sorting/filters affect results. It feels incomplete for a search 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%, so the baseline is 3. The description does not add any parameter-specific meaning; it only explains a behavioral constraint on the output. No additional semantics for keyword, note_type, sort_type, page_token, or publish_time_range are provided.
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 first sentence clearly states the tool's purpose: search notes by keyword. It distinguishes from sibling tools which focus on retrieving specific notes, comments, or user info. However, it does not explicitly contrast with these siblings.
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 no guidance on when to use this tool versus alternatives. There is no mention of prerequisites, context, or when not to use it. The extensive instruction on URL handling is a behavioral note, not usage 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_idAInspect
根据小红书 note_id 提交视频笔记口播转文字任务;提交完成后最多短等 240 秒,未完成时返回 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。 |
| content_id | Yes | 平台内容 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_meta | 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 must fully disclose behavioral traits. It mentions waiting time and return of job_id, but does not disclose potential error conditions, rate limits, or what happens if the note_id is invalid. The description is insufficient for an agent to understand the full behavior.
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, efficient and front-loaded with the core purpose. It could be slightly more structured, but it is clear and concise.
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's mention of job_id and next query action is adequate. It could explicitly reference the sibling tool for polling, but overall it provides sufficient context for a submission workflow.
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 a detailed parameter description for note_id. The description does not add further semantic value beyond the schema. 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 verb (submit), resource (video note speech-to-text task), and identifier (note_id). It distinguishes from sibling tool xhs_submit_video_speech_text_by_note_url by specifying the input type.
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 clear context: after submission wait up to 240 seconds, and if not completed, it returns a job_id and hints at a next query action (likely using xhs_get_video_speech_text_job). However, it does not explicitly state when to use this tool versus the alternative by URL.
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
提交小红书视频笔记口播转文字任务;提交完成后最多短等 240 秒,未完成时返回 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。 |
| content_id | Yes | 平台内容 ID。 |
| transcript | Yes | 成功时的口播转文字结果;非终态或失败时为 null。 |
| is_terminal | Yes | 是否已终态。 |
| next_action | Yes | 非终态时建议的下一步查询动作。 |
| content_meta | 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?
With no annotations, the description carries the burden. It discloses the async behavior, timeout of 240 seconds, and the return of job_id and next action on incomplete jobs. This goes beyond the schema and provides essential 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?
Two sentences with no redundancy. The first sentence states the purpose, the second provides key behavioral details. Efficiently front-loaded and every word adds value.
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?
For a one-parameter submission tool with an output schema, the description covers the async workflow, timeout, and return values. No gaps given the tool's simplicity.
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%, so baseline is 3. The description does not add additional meaning to the note_url parameter beyond what the schema already provides (link, short link, or shared text).
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 resource (Xiaohongshu video note by URL). It distinguishes from sibling tool xhs_submit_video_speech_text_by_note_id which uses note ID, so URL-based submission is uniquely identified.
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 the async nature: wait up to 240 seconds, then either get result or receive job_id and next query action. This implicitly guides when to use (submit task) and when to use sibling xhs_get_video_speech_text_job (to poll). Explicit alternative guidance is missing but context is clear.
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!
Related MCP Servers
- AlicenseAqualityBmaintenanceRead-only MCP bridge for Xiaohongshu / XHS / RedNote social media insights: search notes, get note details and comments, creator profiles, and creator note lists.Last updated141MIT
- AlicenseBqualityFmaintenanceEnables users to search and retrieve content from Xiaohongshu (Red Book) platform with smart search capabilities and rich data extraction including note content, author information, and images.Last updated129427MIT
- Alicense-qualityDmaintenanceEnables AI assistants to search Xiaohongshu notes, analyze favorites, and extract text from images for social media research.Last updated2419MIT