Skip to main content
Glama

generate_songbook

Compiles songbook files into book/book.pdf, cleans stray OS files, validates song syntax, and returns PDF details with an alphabetical table of contents.

Instructions

Compiles the songbook into book/book.pdf using 'evox generate'. Automatically cleans stray OS files from songs/, validates all song syntax, and returns the generated PDF details with the alphabetical Table of Contents.

Input Schema

NameRequiredDescriptionDefault
skip_coverNoPass --skip-cover to omit the cover page (requires evox >= 1.0.3). Defaults to false.
project_dirNoSongbook directory path (defaults to EVOX_PROJECT_DIR or cwd).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/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 substantial work: it discloses a destructive side effect (deleting stray OS files from songs/), a validation gate on all song syntax, the write target (book/book.pdf), and the shape of the return (PDF details plus an alphabetical Table of Contents). What's missing is failure behavior – whether invalid syntax aborts generation or what happens to a pre-existing book.pdf.

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?

Two tightly packed sentences with zero filler; the output artifact and command are front-loaded, and each subsequent clause adds a new behavior (cleanup, validation, return contents) rather than restating anything.

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?

For a 2-parameter, no-required-args tool with no output schema, the description covers what it produces, where it writes, what it mutates, and what it returns. The only meaningful gap is error/failure semantics, which an agent would want before invoking a tool that deletes files and validates the whole corpus.

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 both parameters (skip_cover, project_dir) are fully documented in the schema, including defaults and the EVOX_PROJECT_DIR fallback. The description adds no parameter-level meaning of its own, so baseline 3 applies.

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?

The description states a specific verb and resource ('Compiles the songbook into book/book.pdf') plus the underlying mechanism ('evox generate'), which clearly separates it from read-oriented siblings like get_songbook or get_song. It stops short of naming a sibling or explicitly contrasting with get_songbook, so it is clear but not maximally differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

Usage is only implied: the cleaning and syntax validation steps suggest this is the build/finalization tool to run after songs exist, but there is no explicit 'use this when' statement and no prerequisites (e.g., songs must already exist, evox CLI must be installed) are given. No alternatives or when-not-to-use conditions are named.

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