ypt-mcp

by derived-functor

Overview Schema Source Related Servers Discussions Admin

Python

Local

get_group_members

Retrieve members of a study group with their study hours and current studying status using group and country IDs.

Instructions

Return the members of a study group with their study stats.

:param group_id: Study group ID, e.g. from ``get_my_groups``.
:type group_id: int
:param country_id: Country ID, as returned by ``get_profile``.
:type country_id: int
:returns: List of member mappings with ``user_id``, ``nickname``,
    ``category``, ``study_ms``/``study_hours`` and ``studying``
    (bool, whether the member is currently studying).
:rtype: list[dict[str, Any]]
:raises RuntimeError: If YPT credentials are not configured.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`group_id`	Yes
`country_id`	Yes

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 13, 2026

TDQS

A3.9/5.0

Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the RuntimeError precondition (YPT credentials not configured) and that 'studying' is a live/current-state boolean, both genuinely useful behavioral context. It does not address pagination, size limits, or data-access/privacy constraints on other members.

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?

The purpose is front-loaded in the first line, followed by an organized param/returns/raises block. Some redundancy exists — ':type group_id: int' and the :rtype line restate what the schema and output schema already provide — but nothing is confusing or padded.

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

Completeness4/5

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

Both required parameters are documented, the error case is disclosed, and an output schema exists so enumerated return fields aren't strictly needed (the description lists them anyway). For a simple two-param lookup this is close to complete; only cross-tool usage guidance is thin.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate — and it does, documenting both parameters in Sphinx form with an example source for group_id and a provenance note for country_id. Format details (int) are left to the schema, but the semantic intent of each param is clear.

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

Purpose5/5

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

States a specific verb and resource ('Return the members of a study group') and adds scope detail ('with their study stats'), which cleanly separates it from sibling get_my_groups (lists groups) and get_leaderboard/get_my_rank (rankings). An agent can identify the right tool from the title line alone.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the description tells you where group_id comes from ('get_my_groups') and country_id ('get_profile'), which effectively prescribes a call sequence, but it never says when to prefer this tool over alternatives or any exclusion conditions. Provenance hints are useful but fall short of explicit guidance.

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

Deploy Server