Skip to main content
Glama

Get Compile & Taxonomy Settings

get_compile_settings
Read-onlyIdempotent

Retrieve compile-format definitions and taxonomy from an open Scrivener project to inspect formatting options before compiling.

Instructions

Return the project's compile-format definitions (from Settings/compile.xml) and its taxonomy: the named compile formats and their section-layout counts, the current output file type, label and status definitions (with colors), saved collections, and user-defined section types. Use this to discover what compile formats and metadata categories a project defines before compiling or organizing. Read-only; does not run a compile. If a project has never been compiled, hasCompileSettings is false and only the taxonomy is returned. Requires an open project (call open_project first).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
labelsNoLabel definitions with colors.
optionsNoGlobal compile options.
statusesNoStatus definitions.
collectionsNoSaved collections (binder, saved searches, groups).
sectionTypesNoUser-defined section types (Scene, Chapter, Part Heading, ...).
compileFormatsYesNamed compile formats the project defines.
currentFileTypeNoDefault output file type of the last-used compile (e.g. "pdf").
hasCompileSettingsYesFalse when Settings/compile.xml is absent or unreadable.
Behavior5/5

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

Annotations declare readOnlyHint and idempotentHint true. Description adds behavioral details: returns taxonomy even if never compiled (hasCompileSettings false), and that it requires an open project. No contradictions.

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?

Concise paragraph of 5 sentences, front-loaded with the main action. Every sentence adds value: purpose, usage advice, read-only clarification, special case, and prerequisite. No fluff.

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?

Given zero parameters, comprehensive annotations, and presence of output schema (though not shown), the description fully covers what the tool does, when to use, and edge case (never compiled). Complete for agent decision-making.

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?

No parameters, so baseline 4 applies. Schema coverage is 100% vacuously, and description does not need to add parameter info.

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?

Description uses specific verb 'Return' and resource 'compile-format definitions and taxonomy', clearly distinguishing from siblings like compile_documents. It explains what is returned and when to use it.

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?

Explicitly states 'Use this to discover... before compiling or organizing' and clarifies 'Read-only; does not run a compile'. Mentions prerequisite 'Requires an open project (call open_project first)'. No explicit alternative named but context is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/writerslogic/scrivener-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server