Skip to main content
Glama

spawn_docs

Fetches the Spawn world's engine-matched guide, API reference, and skills index, detecting the pinned engine era and semver, and optionally saving docs under .spawn/.

Instructions

Fetch this world's guide, the Tome API reference, and the skills index — all matched to the engine version the world is pinned to, and this is also the cheapest authoritative answer to WHICH engine that is (era + semver come back in the result). On engine 6.0+ the guide IS the world's AGENTS.md: the tree grammar, the API in one screen, the git loop. On a pre-6.0 world it is the document lane's one paragraph. Optionally save under .spawn/. For just the skill menu with descriptions, spawn_skills is cheaper.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
saveNoWrite guide.md, tome-api.md, skills.json under .spawn/
projectDirNoAbsolute path to the Spawn game project (game.json / .env). Defaults to SPAWN_PROJECT_DIR or the MCP process cwd.
engineVersionNoOptional engine version this call assumes: a semver ('6.0.0', '5.4') or an era name ('6.0' for a git world, 'document' for a pre-6.0 one). Omit it and the world's engine is detected from the API and cached. When passed it is CHECKED against the real pin and a mismatch fails the call without writing anything — it is an assertion, not an override.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • addedInput schema / properties / engineVersion
      Added value: +{
      +  "description": "Optional engine version this call assumes: a semver ('6.0.0', '5.4') or an era name ('6.0' for a git world, 'document' for a pre-6.0 one). Omit it and the world's engine is detected from the API and cached. When passed it is CHECKED against the real pin and a mismatch fails the call without writing anything — it is an assertion, not an override.",
      +  "type": "string"
      +}
  2. First observedv1.2.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses side effects (writes guide.md/tome-api.md/skills.json under .spawn/), that a passed engineVersion is an assertion that FAILS without writing on mismatch, and that engine detection is cached. It stops short of describing return shape or what the failure looks like, but the mutation and idempotency profile is unusually well covered.

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 purpose, then alternatives, in three tight sentences. Vocabulary is dense ('Tome API reference', 'document lane's one paragraph', capitalized 'IS') and assumes domain familiarity, which costs a point but no sentence is filler.

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, so the description correctly compensates by naming what comes back (era + semver) and how guide content differs by engine era. Combined with the schema's full coverage of projectDir/engineVersion, an agent has enough to call it correctly; only the precise failure/output format is left implicit.

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

Parameters3/5

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

Schema description coverage is 100%, so the three parameters are already fully documented in the schema (including the assertion semantics of engineVersion). The description adds only marginal value here — the 'Optionally save under .spawn/' note mirrors the save parameter and the engine-detection note duplicates the schema. Baseline 3 is appropriate.

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?

States a specific verb (fetch) and three concrete resources (this world's guide, the Tome API reference, the skills index), scoped to the pinned engine version. It explicitly distinguishes itself from the sibling spawn_skills ('For just the skill menu with descriptions, spawn_skills is cheaper'), so an agent can route without opening either schema.

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?

Gives explicit when-to-use ('cheapest authoritative answer to WHICH engine that is') and an explicit alternative for the narrower need (spawn_skills for the skill menu). It also describes the version-dependent content an agent will get, which is decision-relevant context for choosing it.

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