Skip to main content
Glama

goodnotes_study_collection_status

Read-only

Retrieve a study collection's progress, source pages, previews, overview URL, and child workflows. Use completed child IDs to plan selective study revisions.

Instructions

Read collection progress, source pages, previews, overview URL and child workflows. Completed child IDs support selective study revisions.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "collectionId": "<collectionId>"
    },
    "name": "goodnotes_study_collection_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
collectionIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.21.1

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive, open-world behavior, so the safety profile is covered. The description adds useful behavioral context beyond that: it discloses the substantive return contents (progress, source pages, previews, overview URL, child workflows) and explains that completed child IDs can be reused for selective revisions. It does not cover pagination or preview limits, but the core behavior is well disclosed.

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?

Two sentences, front-loaded with the returned resource set before the usage hint about completed child IDs. There is no filler, though the second sentence is terse enough to be slightly cryptic without knowing the revision workflow. Overall efficient and well ordered.

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 one-parameter, read-only status tool with no output schema and solid annotations, the description gives an adequate picture of what comes back and why completed child IDs matter. The main remaining gap is how the collectionId is sourced and whether previews are paginated or truncated. That is a minor omission relative to the tool's complexity.

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?

With a single parameter at 0% schema description coverage, the description must carry the meaning, and it only does so implicitly by repeatedly referencing 'collection,' implying that collectionId identifies the collection being inspected. The UUID format and pattern are visible in the schema, so structural details need not be repeated, but the description never says how to obtain the ID or that it scopes the entire read. Partial compensation only.

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?

The description names a specific verb ('Read') and resource ('collection progress') and enumerates the returned artifacts: source pages, previews, overview URL, and child workflows. That distinguishes it from the plan/prepare/run siblings that act on a collection, though it never names those alternatives explicitly. A reader can tell this is the read-only inspection step rather than a mutation or execution step.

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 only implied: 'Completed child IDs support selective study revisions' hints that the tool is used to pick a subset of children before a revision, but there is no explicit when-to-use statement, no exclusions, and no named alternative among the many collection and status siblings. An agent must infer the ordering (status → revision) from the wording rather than being routed.

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