Skip to main content
Glama

QBCore Community Documentation

List QBCore documentation pages

docs_list
Read-onlyIdempotent

Browse the canonical documentation catalog by scope with deterministic pagination. Follow nextOffset until null.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
scopeNo
offsetNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pagesYes
totalYes
nextOffsetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description still earns credit for disclosing the pagination contract ('deterministic pagination', 'follow nextOffset until null'), which is real behavioral information not present in the annotations.

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 tight sentences, zero filler, with the catalog purpose front-loaded and the pagination instruction following immediately.

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?

With annotations covering safety and an output schema covering return structure, the description supplies the missing pagination behavior. It is nearly complete, though the limit parameter and the enumeration-vs-search distinction remain unaddressed.

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 0%, so the description must carry the load. It conveys scope selection and the offset-as-cursor semantics ('nextOffset until null'), but says nothing about the 'limit' parameter or valid scope values, leaving one of three parameters and the enum meaning undocumented.

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?

States a specific verb and resource ('browse the canonical documentation catalog') and adds the scoping dimension ('by scope'). It does not explicitly contrast itself with docs_search or docs_get, so the agent must infer that this is the enumeration path rather than the query path.

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 implied by 'by scope' and the pagination instruction, which suggests browsing an entire category. There is no explicit when-to-use or when-not-to-use guidance, and the sibling docs_search is never named as the alternative for keyword lookups.

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