Skip to main content
Glama

List branches

talentlms_list_branches
Read-only

List the portal's branches (sub-portals: id, name, URL, description, active), paginated. GET /api/v2/branches.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1).
page_sizeNoItems per page, 1-100 (TalentLMS default 10).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this as a safe read, so the bar is lower. The description does add value beyond annotations by disclosing the returned field set and that results are paginated, plus the underlying endpoint. It does not mention total counts, default/max page behavior beyond what the schema says, or rate/auth considerations.

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?

A single compact sentence with the core purpose front-loaded, and the parenthetical field list is dense but earns its place since there is no output schema. Minor cost: the trailing 'GET /api/v2/branches' is implementation detail an agent rarely needs to act on.

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-parameter, no-required-input read tool with no output schema, the description supplies what's missing: the shape of returned branch records and the fact that enumeration is paginated. Remaining gaps are sibling disambiguation rather than anything blocking a correct invocation.

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% — both 'page' and 'page_size' carry their own defaults and 1-100 range — so the schema does the heavy lifting. The description's 'paginated' wording reinforces intent but adds no syntax, format, or edge-case meaning beyond the schema, making the baseline 3 appropriate.

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?

Specific verb ('List') plus resource ('the portal's branches'), with a clarifying gloss that branches are sub-portals and an enumeration of returned fields (id, name, URL, description, active). It is clear what the tool returns, but it never distinguishes itself from near-name siblings like talentlms_get_branch (single branch) or talentlms_list_user_branches (branches per user).

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?

Usage is only implied: the plural 'List' and 'paginated' signal a collection-overview call, so an agent can infer this is for enumerating all branches. However, nothing states when to prefer talentlms_get_branch for a single lookup or talentlms_list_user_branches, and no prerequisites or pagination-stopping guidance are given.

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.