Skip to main content
Glama

Search FiveM documentation

search_docs
Read-onlyIdempotent

Searches RPScripts documentation (installation, downloads, server packs, updates, QBCore/Qbox/ESX guides, compatibility, troubleshooting) and the framework API reference RPScripts reads from pinned QBCore, Qbox, ESX, ox_lib, ox_inventory, ox_target and oxmysql sources. Returns matching sections with source URLs. Pass page to read one docs page in full.

Input Schema

NameRequiredDescriptionDefault
pageNoDocs page path from a result, e.g. "getting-started/downloads"
limitNo
queryNoe.g. "install a server pack", "GetPlayer", "AddItem"
scopeNoall
frameworkNoFramework whose API reference to searchqbcore

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so safety is covered; the description adds genuine value on behavior by stating the return shape ('matching sections with source URLs') and the dual-mode read behavior. It does not mention result ranking, truncation, or error behavior when a page path is invalid.

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?

Three front-loaded sentences with no filler; the coverage list is dense but functional and the mode instruction comes last where it belongs. The parenthetical topic enumeration and the 'reads from pinned ... sources' phrasing are slightly heavy but each element earns its place.

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 5-parameter search tool with no output schema, the description covers scope, source corpora, return shape (sections plus URLs), and the page mode. The main residual gaps are the limit/paging semantics and whether query is mandatory when page is absent.

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?

With only 60% schema coverage, the description compensates well: it explains the two operating modes (query search vs. page fetch), clarifies that 'scope' spans docs versus framework API reference, and that 'framework' selects which API reference is searched. It says nothing about 'limit' behavior, leaving one parameter to the schema alone.

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 gives a specific verb+resource ('Searches RPScripts documentation') and then enumerates the covered topics (installation, downloads, server packs, updates, framework guides, troubleshooting) plus the framework API sources, which clearly separates it from siblings like search_products, get_product and check_compatibility.

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

Usage Guidelines4/5

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

It establishes clear usage context: search documentation and framework API reference, and it explicitly tells the agent how to switch to full-page reading via 'Pass page to read one docs page in full.' It does not name alternatives or exclusion conditions (e.g., when to prefer check_compatibility or lookup_server over a docs search), so it falls short of a 5.

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