Skip to main content
Glama

resource_read

Read-only

List a FiveM resource directory or read a source file line range and return its SHA-256 hash, enabling file inspection and preparation for edits.

Instructions

List a resource directory, or read a line range of a source file with its SHA-256 (needed for resource_edit)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "resource": "<resource>"
    },
    "name": "resource_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNo
fromNo
limitNo
resourceYes
directoryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds meaningful context by disclosing that file reads return a SHA-256 required for resource_edit and that reads can be limited to a line range. It still omits directory-listing behavior such as recursion or return shape.

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?

The definition is a single front-loaded sentence with no redundant wording. Every clause contributes to identifying the operation or its downstream use.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With five parameters, no output schema, and 0% schema description coverage, the description should explain parameter roles and basic return expectations. It explains the file-read SHA-256 purpose but leaves the directory-listing mode and most parameter semantics undocumented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across five parameters, so the description carries the full burden of explaining them. It conveys the concepts of directory listing and line-range reading but never maps these to the file, directory, from, or limit parameters, and it does not clarify the default or maximum limit of 120.

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?

The description states specific verbs and resources: listing a resource directory or reading a line range of a source file, and it explicitly references resource_edit, distinguishing this read operation from the edit sibling. The dual-mode phrasing is compact but slightly ambiguous about which parameters select which mode.

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?

It implies usage before resource_edit by noting the returned SHA-256 is 'needed for resource_edit,' which is useful context. However, it does not explicitly say when to choose directory listing versus file reading, nor how this differs from resource_list or knowledge_read.

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