Skip to main content
Glama

List vignettes in full

dos2_vignettes
Read-onlyIdempotent

Retrieves all campaign vignettes with full story text, questions, answer options, images, and folder details so Game Masters can load illustrated cards shown to players.

Instructions

Returns every vignette of the campaign with its full content: uuid, title, text, question, answer options, image and folder. Vignettes are the illustrated story cards the Game Master shows to players, optionally with a vote.

Read-only. When titles are enough, dos2_campaign is cheaper. Create or change a vignette with dos2_put_vignette
and remove one with dos2_delete_vignette.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "campaign": "<campaign>"
    },
    "name": "dos2_vignettes"
  }
}

Input Schema

NameRequiredDescriptionDefault
campaignYesThe campaign to work on: its name, its folder name, its UUID, or a unique part of any of them. dos2_status lists the campaigns.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / campaign / description
      Added value: +"The campaign to work on: its name, its folder name, its UUID, or a unique part of any of them. dos2_status lists the campaigns."
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered; the description reinforces it with 'Read-only.' and adds genuinely new context: the full field payload and the relative cost versus the lighter sibling. It could still say whether the content includes deleted/hidden vignettes or how large a full dump typically is.

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?

Three short, front-loaded blocks: what you get, safety, then alternatives — each earning its place. Minor waste: 'Read-only.' duplicates the readOnlyHint annotation and the field enumeration partly duplicates the output schema.

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 single-parameter full-list read with an output schema present, nothing an agent needs is missing: expected payload, cost trade-off versus the lighter sibling, and routing to the write/delete tools are all stated.

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% and the single 'campaign' parameter is already documented as accepting name, folder name, UUID, or unique fragment, with a pointer to dos2_status. The description adds no further meaning to that parameter, so the baseline 3 applies.

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 and resource ('Returns every vignette of the campaign with its full content') and enumerates the exact payload (uuid, title, text, question, answer options, image, folder). It even defines the domain object — illustrated story cards shown to players, optionally with a vote — so an agent knows what it is fetching without consulting any 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?

Explicitly routes the agent: when only titles are needed, dos2_campaign is cheaper; creating or changing goes to dos2_put_vignette; removal goes to dos2_delete_vignette. Both the read alternative and the two mutation alternatives are named with the condition that selects each.

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