Skip to main content
Glama

RedM Mcp

by no.fivem.redm-mcp
OverviewDiscussionsAdmin

Get full RedM doc

get_document
Read-only

Fetch a document or a complete discovery: record using the path returned by browse, semantic_search, discovery_lookup or grep_docs. For ordinary documents, heading selects a section (full breadcrumb or leaf; case-insensitive and fuzzy); deep sections include the parent's introduction. Structured discovery records include metadata and source commit/line references and need no heading. For animation/audio/IMAP/clothing/wearable/particle/flag/texture lookups start with discovery_lookup; for individual natives use lookup_native. Selected Lua files also support top-level catalog keys as heading; arbitrary source line ranges require read_lines with the raw sourcePath. Community findings use learning:N paths. Missing documents return available headings and recovery hints.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesUse a returned path verbatim: a relative document path, learning:<id> for a finding, discovery:<id> for a structured discovery record, or refdoc:<slug> for a native reference table. For raw source lines use sourcePath with read_lines.
headingNoOptional prose heading from the doc, e.g. `Add Item to User` or `Character Management > Inventory Management`. Case-insensitive, fuzzy match on the leaf (text after the final `>`). NOT for code symbols — `addItem`, `getPlayerPed` etc. won't match; use `grep_docs` for those.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"Doc path. Two valid shapes: (a) `<category>/<file>.md` for docs, e.g. `vorp/vorp_core_docs.md`; (b) `learning:<id>` for community findings, e.g. `learning:11`. Use the path returned by `browse`/`semantic_search`/`grep_docs` verbatim — do not invent `learnings/<slug>.md`."New value: +"Use a returned path verbatim: a relative document path, learning:<id> for a finding, discovery:<id> for a structured discovery record, or refdoc:<slug> for a native reference table. For raw source lines use sourcePath with read_lines."
  2. Changed2 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
  3. Changed2 schema fields changed
    • changedInput schema / properties / heading / description
      Previous value: -"Optional heading. Matches case-insensitive on full path or last segment."New value: +"Optional prose heading from the doc, e.g. `Add Item to User` or `Character Management > Inventory Management`. Case-insensitive, fuzzy match on the leaf (text after the final `>`). NOT for code symbols — `addItem`, `getPlayerPed` etc. won't match; use `grep_docs` for those."
    • changedInput schema / properties / path / description
      Previous value: -"Relative path, e.g. vorp/vorp_core_docs.md"New value: +"Doc path. Two valid shapes: (a) `<category>/<file>.md` for docs, e.g. `vorp/vorp_core_docs.md`; (b) `learning:<id>` for community findings, e.g. `learning:11`. Use the path returned by `browse`/`semantic_search`/`grep_docs` verbatim — do not invent `learnings/<slug>.md`."
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

The annotation readOnlyHint=true already covers the read-only nature, so the description doesn't need to restate it. It adds valuable behavioral context: heading matching is case-insensitive and fuzzy, deep sections include parent introductions, missing documents return available headings and recovery hints. This goes beyond annotations without contradicting them.

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?

The description is a single dense paragraph but each sentence earns its place. The core purpose is front-loaded, followed by usage guidance and edge cases. It's slightly long but not padded; the structure flows logically from purpose to alternatives to specifics.

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?

For a tool with no output schema and moderate complexity, the description is complete. It covers path sources, heading behavior, special cases (discovery, Lua keys, source lines), and error handling (recovery hints). An agent has everything needed to call it correctly without external documentation.

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?

Although schema description coverage is 100% (both path and heading are described in the schema), the description adds meaning beyond the schema: it explains that heading is fuzzy and case-insensitive, warns against code symbols, and clarifies that structured records need no heading. This enriches the schema's bare field definitions.

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 opens with a specific verb and resource: 'Fetch a document or a complete discovery:<id> record', and explicitly names the tools that return the paths to use (browse, semantic_search, discovery_lookup, grep_docs). This clearly distinguishes it from siblings and leaves no ambiguity about what the tool does.

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?

The description provides explicit when-to-use guidance and names alternatives: for animation/audio/IMAP/clothing/etc. use discovery_lookup, for individual natives use lookup_native, for raw source lines use read_lines. It also explains that community findings use learning:N paths and that heading selection differs for structured records. This is exemplary routing.

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

All RedM Mcp toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources