Skip to main content
Glama

List knowledge base articles

list_kb_articles
Read-onlyIdempotent

Search Atera knowledge base articles by text across product, keywords, category, section, or content, with paging and limits to return matching records.

Instructions

Knowledge base articles. With query, scans articles whose product, keywords, category, section or content contains it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fullNoReturn every field of each item instead of a summary (much larger output)
pageNoPage number, starting at 1 (default 1)
limitNoMaximum number of matches to return (default 20)
queryNoText to look for (case-insensitive)
maxPagesNoMaximum pages of 50 items to scan (default 10, i.e. 500 records)
itemsInPageNoItems per page (default 20, max 50)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and non-destructive behavior, so the safety profile is covered. The description adds one genuine insight: with a query the tool scans across product, keywords, category, section and content, which hints at the cost/scope of a scan. It still says nothing about pagination behavior or result ordering.

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 short sentences, no filler. The scan-scope detail is the only substantively useful content and it is not buried.

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?

With six fully documented parameters, annotations covering the safety profile, and no output schema, the definition is adequate but thin. It does not explain the paged maxPages/itemsInPage interaction or what a returned summary item looks like, which are the main remaining ambiguities for a list tool.

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 description coverage is 100%, so a baseline of 3 applies, but the description goes beyond the schema by naming the exact fields the 'query' parameter matches against (product, keywords, category, section, content) — a detail the schema omits. The other five parameters are left to the schema.

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

Purpose3/5

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

The description opens with a bare noun phrase, 'Knowledge base articles,' which essentially restates the name and title rather than stating a verb. The second sentence does clarify the tool's filtering behavior, but the core 'what it does' (list/retrieve articles) is only implied.

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?

There is no guidance on when to use this tool versus siblings such as get_department or list_tickets, nor any statement of prerequisites or when it should not be used. The query sentence implies a search use case but never frames it as a decision criterion.

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