Skip to main content
Glama

Agent reference docs

docs
Read-onlyIdempotent

Talkfirst reference for the assistant: without topic, the list of topics and when to read them; with a topic, its text (start, vocab, quiz, talk, pronounce, plan, pace, lessons).

Input Schema

NameRequiredDescriptionDefault
topicNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so safety is covered. The description adds genuinely new behavioral context: the tool is dual-mode and its return content differs by whether topic is supplied (and enumerates the topic names). It stops short of describing the response format beyond that.

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

Conciseness5/5

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

One sentence, no filler, front-loaded with the tool's identity and then immediately branching into the two modes with a parenthetical enum. Nothing to trim.

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?

With no output schema, the description usefully previews both return shapes and the topic vocabulary, and annotations cover the safety profile. It is close to complete for a one-parameter lookup tool; the only gap is how topics relate to sibling surfaces such as lessons or plan.

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 0% and the sole parameter has no schema description, so the description must carry the load — and it does, explaining that an absent/empty topic yields the topic list while a supplied topic yields that topic's text, plus the set of valid topic values. Only the exact accepted spelling/format of topic values is left unstated.

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 pattern: it returns reference documentation, and it explicitly enumerates its two modes (topic list vs. topic text). The dual-mode framing distinguishes it from a plain 'topics' or 'lessons' lookup, though it never names those siblings. Purpose is clear but not explicitly differentiated from adjacent tools.

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

Usage Guidelines4/5

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

Gives explicit invocation guidance per mode: call with no topic to get the list of topics and when to read them; call with a topic to get that topic's text. It does not say when to prefer this over siblings like 'topics', 'lessons', or 'plan', so the routing guidance is incomplete.

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