Skip to main content
Glama

list_forums

Read-only

List standard Moodle forums for one or more specified course IDs, separate from PLATO notice and Q&A boards. Use to retrieve forum discussions for courses.

Instructions

List standard Moodle forums across one or more courses. NOT the same as PLATO's notice/Q&A board (use list_notices/list_qna for that) -- this covers the separate, less-commonly-used mod_forum module.

Input Schema

NameRequiredDescriptionDefault
course_idsYesOne or more course ids to list forums for.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/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=true, covering the safety profile. The description adds useful disambiguation about the mod_forum module but does not disclose auth requirements, pagination, or rate-limit behavior; with annotations present, that is a reasonable but not rich contribution.

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?

The definition is two sentences with no wasted text, and the primary purpose is front-loaded before the disambiguation caveat. The capitalized warning is slightly informal but directly serves routing clarity.

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?

This is a low-complexity, single-parameter read tool with a fully described schema, annotations, and an output schema. The description supplies the sibling distinction needed for correct selection and omits return-value details that the output schema already covers.

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?

Schema description coverage is 100%, so the only parameter, course_ids, is already documented in the schema. The description's phrase 'across one or more courses' reinforces that multiple IDs are allowed but adds little beyond the schema, matching the baseline 3 for high-coverage schemas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('List standard Moodle forums') and scopes it to 'one or more courses'. It explicitly distinguishes this tool from sibling notice/Q&A boards and names the underlying mod_forum module, so an agent can identify it without inspecting the schema.

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

Usage Guidelines5/5

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

It gives explicit when-not guidance ('NOT the same as PLATO's notice/Q&A board') and names the alternative tools to use instead ('use list_notices/list_qna for that'). The when-to-use case is also clear: retrieving standard Moodle forum listings across courses.

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