Skip to main content
Glama
Txpple

fvtt-mcp-molten5e

by Txpple

read-pack

Reads a Foundry scene-pack module from disk, normalizes its scenes and journals across Foundry eras, and returns paged data with asset rewrite hints for import.

Instructions

Read a Tom-Cartos-style Foundry SCENE-PACK MODULE off disk (a module.json + LevelDB/NeDB compendium packs — Scene/JournalEntry packs AND modern type:"Adventure" packs whose single Adventure doc embeds every scene/journal) and return its era-normalized documents for import. OFF-LINE and Node-only: it reads files, never the live world. Detects the pack's Foundry era from field shape (older v10/NeDB vs newer v13/LevelDB), extracts each Scene (dimensions, grid, background, thumbnail, walls, lights, regions/teleporters) and JournalEntry (pages), strips cli pack artifacts, and — when given the destination root the skill chose — emits per-asset path REWRITE HINTS (the module-relative %-encoded src → a clean Data-relative path). Also discovers any standalone TILE images the pack ships (building/prop pieces with a Tile_<W>x<H> grid footprint in the name, not referenced by any scene) so the skill can make them available for the GM to drop onto scenes. The heavy per-scene walls/lights/regions are written to PAYLOAD FILES and referenced by placeablesPath (NOT inline — the response cap truncates them at scene scale); pass that path to create-scene, which reads it server-side. The skill then uploads the assets, recreates the scenes/journals, and (modern packs) remaps the cross-scene teleporters. Handles all eras: modern v13/LevelDB (via the @foundryvtt/foundryvtt-cli child process) AND legacy v10/NeDB .db (parsed directly — no cli needed). The full manifest is PAGED to fit the response cap: returns totalScenes + a page of scenes + nextOffset (call again with offset until null). Pass index:true first for a tiny names-only survey of the whole pack (variant planning + dedup) before paging the heavy import.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexNoSurvey mode: return ONLY the lightweight scene list ({sourceId, name, counts}) + descriptor + journal names — no paths, payloads, or assets. Call this ONCE to plan variant selection and dedup across the whole pack before paging the full import (the full manifest is capped/paged).
offsetNoIndex of the first Scene to return (for paging a big pack). Default 0.
destRootNoData-relative asset destination root the skill chose (e.g. "worlds/<world>/assets/tom-cartos/<module-id>"). When set, every referenced asset gets a `dataPath` rewrite hint (modules/<id>/<rel> → <destRoot>/<rel>, percent-decoded) so the create tools receive already-correct paths. Omit to get the decoded module-relative paths only.
packNameNoOnly read this pack (matched against module.json packs[].name). Default: all packs.
modulePathYesAbsolute path to the unzipped module folder OR directly to its module.json.
sceneLimitNoPage size: how many Scene records to return this call (default 10). The manifest must fit the MCP response cap, so a big pack is read in pages — import a page, then call again with `offset` advanced by the returned count until `nextOffset` is null.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.2

TDQS

A4.6/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It extensively discloses key behaviors: off-line and Node-only, reads files rather than live world, writes heavy per-scene data to payload files (referenced by placeablesPath), pages results to fit response cap, has an index mode, and handles different Foundry eras. It also mentions stripping cli pack artifacts and discovering standalone tile images. This is a thorough behavioral disclosure for a complex tool.

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 long but appropriately so for a tool of this complexity. It is front-loaded with the primary purpose in the first sentence, then progressively details behaviors, paging, and usage. Each sentence adds necessary context—off-line nature, era detection, extraction scope, payload files, index mode. It could be slightly more concise, but it is well-organized and not redundant.

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?

There is no output schema, so the description must explain what the tool returns. It does so clearly: returns totalScenes, a page of scenes, nextOffset for paging, and in index mode a lightweight list. It also explains the payload file mechanism and the rewrite hints. Given the tool's complexity and the absence of structured output metadata, the description covers everything an agent needs to call and process results correctly.

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?

Schema description coverage is 100%, so baseline is 3. The description adds operational meaning beyond the schema: it explains the purpose of index mode for survey and dedup, how offset and sceneLimit interact for paging, and that destRoot triggers rewrite hints. It clarifies the role of modulePath and packName in the import flow. This adds real value, though the schema already describes each parameter, so not a 5.

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 states a specific verb ('Read'), a specific resource ('Tom-Cartos-style Foundry SCENE-PACK MODULE'), and its purpose ('return its era-normalized documents for import'). It clearly distinguishes itself from siblings like create-scene by emphasizing it is off-line and reads files, not the live world. 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 Guidelines4/5

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

The description clearly indicates when to use this tool: it is for reading a pack from disk in an import workflow, explicitly noting it is 'OFF-LINE and Node-only' and 'never the live world', which differentiates it from live-world tools. It also provides usage flow (index first, then page, then pass placeablesPath to create-scene). However, it does not explicitly name alternative tools to use instead, only downstream steps, 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.

Deploy Server

Other Tools