Skip to main content
Glama

Notematics

Read a board

read_board
Read-onlyIdempotent

Reads the board behind a Notematics link the user gave you and returns it as board text, in the same format you write. Ink, images, widgets and the audio of narration cannot be written as text and are listed as left out (narration text is kept, as :::say; the wire man or girl as :::companion and the moods as :::mood; how steps appear as :::show; the marks drawn over what is written as :::strike, :::circle… lines; the look of words as spans). For a live link it also says which page the teacher is on.

Input Schema

NameRequiredDescriptionDefault
linkYesThe Notematics link the user gave you, exactly as given: .../live/<id> (the board open now) or .../s/<id>#<key> (a shared copy).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, non-destructive, closed-world behavior, and the description adds substantial context beyond that: lossy extraction (ink, images, widgets dropped), retention of narration as :::say, companion and mood markers, markup for strike/circle and styled spans. It also discloses that live links report the teacher's current page, a behavior not derivable from schema or annotations.

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?

Purpose and return format are front-loaded in the first clause, before the enumeration of markup. The single long sentence with a deep parenthetical is dense and less scannable than it could be, but essentially every clause carries information the agent needs about the lossy return format.

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

Completeness5/5

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

There is no output schema, and the description compensates by describing the returned text format, the content that is dropped, and the markup conventions used. For a one-parameter read-only tool, nothing an agent needs in order to interpret or use the result is missing.

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 coverage is 100% and the schema already documents the live vs shared link forms with examples. The description still adds meaning by tying parameter type to outcome ('For a live link it also says which page the teacher is on'), clarifying why the distinction matters functionally.

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 ('Reads the board behind a Notematics link') and immediately says what comes back ('returns it as board text, in the same format you write'). The phrase 'in the same format you write' implicitly steers away from a format-definition sibling like get_board_format, but no sibling is named explicitly.

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?

The trigger is implied rather than stated: it operates on 'a Notematics link the user gave you', which suggests when the tool applies. There is no explicit when-not guidance and no mention of alternatives such as check_board or get_board_format, leaving the agent to infer routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources