Skip to main content
Glama

tool_compile_project

Compile a Ren'Py project to validate .rpy syntax and return structured errors with file paths and line numbers. Clear .rpyc cache when force is enabled to pick up file changes.

Instructions

Compile a Ren'Py project (validate syntax).

Runs Ren'Py's compiler on all .rpy files. Returns structured errors with file paths and line numbers if compilation fails.

Args: project_path: Absolute path to the Ren'Py project root directory. force: If True, clear .rpyc cache before compiling (to pick up file changes).

Returns: dict with {ok: bool, errors: [{file, line, message}], raw_output: str}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNo
project_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.9/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 mostly succeeds: it says the compiler runs over all .rpy files and that failures produce structured errors with file paths and line numbers, and it explains what force does (clearing the .rpyc cache). It does not disclose that successful compilation writes .rpyc artifacts or any cost/duration characteristics, which is the remaining gap.

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?

Front-loaded purpose sentence, then compact Args/Returns sections with no filler. Every line adds information an agent would otherwise have to guess.

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, and the description compensates by spelling out the return dict shape (ok, errors with file/line/message, raw_output). Combined with the full parameter documentation and error semantics, the definition is close to self-sufficient; only the missing sibling differentiation keeps it short of complete.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate, and it does: project_path is pinned as an absolute path to the project root, and force is explained as clearing the .rpyc cache so file changes are picked up. Both parameters gain meaning beyond their bare schema types and defaults.

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?

States a specific verb and resource ('Compile a Ren'Py project') and adds scope ('validate syntax', 'all .rpy files'). However, it never distinguishes itself from closely related siblings such as tool_lint_project and tool_check_project, so the agent can't route between them from the description alone.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance and no mention of alternatives. The implied 'validate syntax' framing hints at a pre-run check, but with three overlapping validation siblings (compile/lint/check) present, the absence of any disambiguation is a real gap.

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