Skip to main content
Glama

yuque_get_doc_statistics

Retrieve document statistics for a Yuque group, including read, like, comment, and word counts, with filters by repository, date range, or document name.

Instructions

Get group document statistics. GET /groups/:login/statistics/docs. 详见 references/api/statistic_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoFilter by document name
pageNoPage number, default 1
limitNoPage size, max 20, default 10
loginYesGroup login or ID (required)
rangeNoDate range: 0=all, 30=last 30 days, 365=last year (default 0)
bookIdNoFilter by repository ID
sortFieldNoSort field: content_updated_at, word_count, read_count, like_count, comment_count, created_at
sortOrderNoSort order: desc (default) / asc

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries full behavioral burden. It doesn't state read-only nature, permission requirements, whether the result is paginated (though page/limit params imply it), or what the statistics consist of. The endpoint reference and doc link are the only added context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Very compact – one purpose sentence, an endpoint hint, and a doc reference. Front-loaded purpose is fine, though the Chinese doc pointer is opaque to non-Chinese readers and adds little routing value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter, no-output-schema, no-annotation statistics tool with several close siblings, the description is thin. It neither clarifies scope vs the other statistics tools nor hints at the return shape, permissions, or pagination behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all 8 parameters are documented in the schema with non-trivial detail (enums for range, sortField, sortOrder values). Description adds no parameter meaning beyond the schema, which is the baseline 3 case when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb+resource ('Get group document statistics') and even names the HTTP endpoint. However, it does not differentiate from close siblings like yuque_get_group_statistics, yuque_get_book_statistics, or yuque_get_member_statistics, leaving the agent to infer scope from the name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no exclusions, and no mention of the competing statistics tools in the sibling list. The endpoint string hints at group scope but nothing routes the agent between this and the other *_statistics tools.

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