Skip to main content
Glama

nui_list

Read-only

List FiveM resources with NUI pages and indicate whether each displays visible content, with an option to return only visible resources.

Instructions

List resources with an NUI page and whether each shows visible content

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "nui_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
visibleOnlyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3/5.0
Behavior3/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 the useful detail that results include a visibility indicator, but says nothing about ordering, pagination, or what "visible content" means in practice. With annotations carrying the safety burden, a 3 is appropriate.

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?

A single front-loaded sentence with no filler. It is slightly awkward in construction ("List resources ... and whether each shows ..."), but nothing is wasted.

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

Completeness3/5

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

For a simple read-only single-parameter tool with annotations and no output schema, the description covers the core purpose. The unaddressed visibleOnly parameter and its default-filter behavior are the notable remaining gap an agent would need before calling it correctly.

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%, so the description must explain the sole parameter visibleOnly. It never mentions the parameter, its default of true, or what passing false would change. The phrase "whether each shows visible content" gestures at the concept but does not connect it to the filter.

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 ("List") and a scoped resource ("resources with an NUI page") plus the extra attribute returned (whether each shows visible content). This distinguishes it reasonably from the generic resource_list sibling, though it never names that sibling explicitly.

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

Usage Guidelines2/5

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

No when-to-use, when-not-to-use, or alternative is stated. The phrase "resources with an NUI page" implies a scope filter, but an agent must infer that resource_list should be used for all resources and nui_snapshot/nui_eval for deeper inspection.

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