Skip to main content
Glama

QBCore Community Documentation

Read a QBCore documentation page

docs_get
Read-onlyIdempotent

Read Markdown at a canonical path returned by docs_search or docs_list. Follow nextOffset until null to obtain the complete article. Does not fetch arbitrary URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
offsetNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
pathYes
scopeYes
titleYes
formatYes
offsetYes
contentYes
nextOffsetYes
provenanceYes
totalCharsYes
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false, and destructiveHint=false. The description adds useful behavioral context about pagination (follow nextOffset until null) and input restrictions (canonical paths only, no arbitrary URLs). It does not cover edge cases like invalid-path errors or rate limits, but for a safe read operation this is solid.

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?

Three sentences, front-loaded with the core action and scope. Each sentence earns its place: usage source, pagination instruction, and input exclusion. No filler or repetition.

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?

Output schema exists, so return values need not be described. Annotations cover the safety profile. The description supplies the missing operational context: where valid paths come from, how to paginate, and what the tool does not do. Complete for a simple two-parameter read 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 0%, so the description must carry parameter meaning. It explains that 'path' must be a canonical path from docs_search or docs_list, and that pagination uses 'nextOffset' until null, implicitly covering the 'offset' parameter. It does not explicitly say to pass nextOffset as offset or restate the numeric constraints, but it adds substantial value over the bare schema.

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?

States a specific verb (Read) and resource (Markdown documentation page) and explicitly limits scope to canonical paths returned by docs_search or docs_list. This clearly distinguishes it from the sibling search/list tools.

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 states when to use it (a canonical path from docs_search or docs_list), how to use it (follow nextOffset until null to get the complete article), and an explicit exclusion (does not fetch arbitrary URLs). The alternatives docs_search and docs_list are named as the source of valid paths, leaving little to inference.

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