Skip to main content
Glama
Sign In
Catalyst MCP for FiveM

Catalyst MCP for FiveM

by Geckomacabre
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

ptfx_vanilla_index

Builds a cached index of every vanilla GTA V Legacy particle effect from your local game archives so FiveM searches and edits can resolve the correct .ypt copy without modifying the install.

Instructions

Build (once; a few minutes) the index of every vanilla effect in your own GTA V Legacy install: reads the game's archives (keys come from your GTA5.exe; nothing is written to the game folder) and caches the best copy of each .ypt (DLC > patch > base, ptfx_hi preferred). game: the folder with GTA5.exe (auto-detected if omitted). refresh rebuilds.

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": "ptfx_vanilla_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
gameNo
refreshNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With only readOnlyHint=false and openWorldHint=false supplied, the description carries the burden well: it discloses that archives are read, keys come from GTA5.exe, nothing is written into the game folder, a cache is produced, and the operation is slow. It does not say where the cache lives or how failures (missing install, missing keys) are reported.

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?

Front-loaded with the verb, the one-time nature, and the cost estimate, and every clause (key source, no writes to the game folder, precedence rules) adds information. It is a single dense run-on with nested parentheses, which slightly hurts scanability.

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?

No output schema exists, and the description covers the essentials for a prerequisite indexing job: inputs, cost, side effects, and file-selection precedence. Gaps are minor (cache location, behavior on a missing or invalid install, whether new DLC requires a refresh).

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

Parameters5/5

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

Schema coverage is 0%, yet the description fully defines both parameters in prose: game is the folder containing GTA5.exe and is auto-detected when omitted, and refresh triggers a rebuild. No parameter is left for the agent to guess.

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 and resource: 'Build ... the index of every vanilla effect' in the user's GTA V Legacy install, plus exactly what is indexed (.ypt files with DLC > patch > base precedence). It is clearly a prerequisite indexing step distinct from the query/edit siblings, though it never names an alternative to contrast against.

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?

Gives real usage context: run once, costs a few minutes, and use refresh to rebuild instead of re-running blind. It does not explicitly say 'call this before ptfx_vanilla_search/get' or state what to do if an index already exists, so the ordering with siblings is inferred rather than stated.

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

Deploy Server

Other Tools