Skip to main content
Glama
derived-functor

ypt-mcp

by derived-functor
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_profile

Fetch the logged-in YPT user's profile and today's study overview, including subjects, study time, and today's day log.

Instructions

Return the logged-in YPT profile with today's study overview.

:returns: Mapping with ``nickname``, ``email``, ``category_code``,
    ``category_id``, ``country_id``, the ``subjects`` list
    (``id``, ``title``, ``study_ms``/``study_hours``, ``archived``) and
    the ``day_log`` for today (see the day-log shape in
    ``get_day_log``).
:rtype: dict[str, Any]
:raises RuntimeError: If YPT credentials are not configured.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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 credential prerequisite via ':raises RuntimeError: If YPT credentials are not configured.' and describes the returned mapping fields, which is meaningful behavioral context for a read operation.

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 first sentence front-loads the purpose cleanly and the rest is structured reST. The returns block partially duplicates the existing output schema, but it is compact and the cross-reference to get_day_log earns its place.

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?

For a zero-param, read-only session tool with an output schema, the description is adequate: purpose, return shape, and the credential failure mode are all covered. It omits only minor details such as whether the profile is cached or how the day_log boundary is computed.

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?

The tool takes zero parameters, so there is nothing to disambiguate; baseline 4 applies. The schema is fully described and the description adds no conflicting parameter guidance.

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

Purpose4/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 logged-in YPT profile with today's study overview.' That distinguishes it from sibling reads like get_my_groups and get_my_rank, though it never explicitly contrasts itself with those alternatives.

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 by the resource (fetch your own profile), but there is no explicit when-to-use guidance or named alternative. It relies on the agent inferring that this is the entry point for identity/session context rather than a filtered query like get_day_log.

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

Deploy Server

Other Tools