Skip to main content
Glama

yuque_get_book_statistics

Retrieve statistics for books in a Yuque group, including word count, post count, and read count, with sorting and date range filters.

Instructions

Get group repo statistics. GET /groups/:login/statistics/books. 详见 references/api/statistic_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoFilter by repository 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)
sortFieldNoSort field: content_updated_at_ms, word_count, post_count, read_count, like_count, watch_count, comment_count
sortOrderNoSort order: desc (default) / asc

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.5/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. The GET endpoint implies a read-only operation, which is the only real behavioral signal, but there is nothing about the returned statistics shape, pagination behavior, or the external reference file's contents.

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

Conciseness3/5

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

The description is short and front-loads the purpose, which is good. The trailing Chinese pointer to references/api/statistic_api.md does not convey actionable information to the agent and occupies one of only three fragments.

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 a 7-parameter statistics tool with no annotations and no output schema, the description is too thin: it never explains what statistics are returned or how paging interacts with the filter/sort parameters. The endpoint path is the only supplementary context provided.

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 seven parameters (name, page, limit, login, range, sortField, sortOrder) are already documented in the schema including defaults and allowed values. The description adds nothing beyond that, so the baseline 3 applies.

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 specific verb ('Get') and resource ('group repo statistics'), and the endpoint path clarifies it targets book-level statistics within a group. However, 'repo statistics' is loosely distinguished from the sibling yuque_get_group_statistics and yuque_get_doc_statistics; an agent cannot confidently tell which one to pick without guessing.

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 mention of prerequisites, and no direction to or away from the alternatives such as yuque_get_group_statistics. The pointer to a Markdown file is a documentation location, not usage guidance.

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