Skip to main content
Glama

AIML Rounds

Role roadmap

roadmap
Read-only

The study roadmap for a role (AI Engineer, ML Engineer, Data Scientist): topics in order, core vs useful, each with its lessons and quiz. No role: list the roles.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "roadmap"
  }
}

Input Schema

NameRequiredDescriptionDefault
roleNo'ai-engineering', 'ml-engineering' or 'data-science' (names like 'AI engineer' work too)
with_lessonsNoInclude lesson titles and ids for each topic

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds a useful picture of the returned structure (ordered topics, core vs useful, lessons and quiz), but says nothing about size, pagination, or caching for a fixed curriculum.

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?

Two terse sentences, front-loaded with the primary behavior and followed by the no-argument fallback; nothing is redundant 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?

For a two-optional-parameter read tool with no output schema, the description covers both invocation paths (with and without a role) and the shape of the returned content. Only minor gaps remain, such as how the lessons/quiz nesting interacts with with_lessons=true.

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%, so the baseline is 3, but the description adds genuinely new meaning: omitting role lists the available roles, which the schema does not explain for an optional parameter. It also frames the two example role values in prose, reinforcing the slug format beyond the schema text.

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 states a specific resource (a role's study roadmap) and its exact composition: ordered topics, core vs useful, each with lessons and quiz. That distinguishes it implicitly from the lesson-level and quiz-level siblings, though it never names them.

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 only guidance is the calling convention 'No role: list the roles', which clarifies the optional-parameter path but not when to reach for this tool over get_lesson, quiz, or browse. Usage is implied by the described output rather than stated.

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