Skip to main content
Glama

Create compendium

create-compendium

Create a new world compendium to organize content like finished campaign chapters. Specify a label and document type (Actor, Item, Scene, etc.) to archive.

Instructions

Create a new world compendium, for example to archive a finished chapter of a campaign. Choose the document type it will hold. Needs the compendium permission on "create and change".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYesDocument type it will hold: Actor, Item, Scene, JournalEntry, RollTable, Playlist, Macro, Cards or Adventure
labelYesName shown in Foundry, for instance "Chapter One: The Sunken Keep"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv14.2609.4

TDQS

A4.3/5.0
Behavior4/5

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

Annotations indicate this is a write operation (readOnlyHint: false). The description adds the crucial permission requirement ('create and change') and specifies that it creates a world compendium, providing useful behavioral context beyond the structured annotations.

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?

Three concise, front-loaded sentences: action+example, parameter guidance, and permission requirement. Every sentence adds value with no redundant phrases.

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?

For a simple 2-parameter creation tool with no output schema, the description covers the purpose, parameter usage, and a critical prerequisite. No additional information is needed for correct invocation.

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% with both 'type' and 'label' fully explained. The description adds minimal extra value—only echoing the type choice and providing an example for label that is already in the schema. Baseline 3 is appropriate since the schema carries the semantic load.

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 clearly states the action 'Create a new world compendium' with a concrete example ('archive a finished chapter'). It also specifies the parameter purpose ('Choose the document type it will hold'), making the tool's function unambiguous and distinct from sister tools like delete-compendium.

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?

Provides a clear use case ('to archive a finished chapter of a campaign') and a prerequisite permission ('Needs the compendium permission on create and change'). It doesn't explicitly contrast with alternative compendium tools, but the example and action make the intended scenario evident.

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