Skip to main content
Glama

Browse full course outline

bb_browse_course
Read-only

Browse a course's full outline by recursively flattening modules, folders, and items with IDs, handlers, and visibility, so you can locate content and permissions from one result set.

Instructions

Recursively flatten the entire course outline (modules, folders and items) with ids, handlers and visibility.

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": {
      "courseId": "<courseId>"
    },
    "name": "bb_browse_course"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum results, default 50
offsetNo
courseIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds valuable context: the tool recursively flattens the hierarchy (not just the top level) and returns ids, handlers, and visibility. However, it does not reconcile 'entire' with the paginated limit/offset parameters and says nothing about page size limits or truncation, which is the main behavioral risk for a read tool like this.

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 description is a single dense sentence with the key concept, recursion, front-loaded, and no filler. Its brevity comes at a small cost: the return contract (ids, handlers, visibility) is packed into a trailing clause and is not separated from the scope claim.

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

Completeness3/5

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

For a simple three-parameter read tool with no output schema, the description covers what the tool returns and how deep it goes, which is a reasonable baseline. The gaps are the undocumented courseId and offset parameters and the unexplained interaction between 'entire outline' and pagination.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 33%: only 'limit' is documented inline, while 'offset' and the required 'courseId' have no schema descriptions at all. The description compensates for none of this: it does not mention pagination, the maximum of 200, the default of 50, or what courseId denotes. Because it adds no meaning beyond the schema, it falls short of the baseline for low-coverage schemas.

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 uses a specific verb ('recursively flatten') and a specific resource ('the entire course outline'), and it enumerates what the outline contains (modules, folders, items). It does not name the closely related siblings such as bb_get_course_content, so an agent cannot tell from the text alone which of those two to pick.

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

Usage Guidelines2/5

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

The description does not say when to use this tool instead of bb_get_course, bb_get_course_content, or bb_get_content, and it states no prerequisites or exclusions. The only usage cue is implicit: the word 'recursively' suggests that this tool is used for exhaustive outlines.

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