Skip to main content
Glama

check_project

Read-only

Retrieve Godot project metadata, including name, path, version, and structure, along with live runtime status to verify if the game is running and responsive before driving it.

Instructions

Get project metadata (name, path, Godot version, structure summary) plus an always-present runtime block reporting whether a runtime session is active, its bridge is responsive, and its process is alive. Omit projectPath for just the Godot version and runtime status. Use as the first call before driving a running project. Never errors on the runtime probe itself. Returns: { name?, path?, structure?, godotVersion, runtime }. Errors if projectPath is set but lacks project.godot.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectPathNoPath to the Godot project directory (optional - omit to get Godot version and runtime status only)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
pathNo
runtimeYes
structureNo
godotVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.8.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, and the description adds meaningful behavioral context: the runtime probe is always present, never errors on the runtime probe itself, and errors only if projectPath is set but lacks project.godot. This goes beyond the annotation by disclosing error conditions and the always-present runtime block.

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?

The description is compact and front-loaded: the main purpose is in the first sentence, the optional-parameter behavior is stated next, and the error condition is last. Every sentence earns its place with no filler.

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 the output schema exists, the description doesn't need to explain return values in detail, but it still summarizes the return shape. It covers the optional parameter behavior, error conditions, and usage context. Nothing an agent needs to call this tool correctly is missing.

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?

Schema coverage is 100% and the schema already describes projectPath. The description adds value by explaining the consequence of omitting it (returns only Godot version and runtime status) and the error condition when set to a non-project directory. This is more than the schema provides, though the schema already covers the basic meaning.

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 states a specific verb ('Get') and resource ('project metadata'), enumerates the exact fields returned (name, path, Godot version, structure summary), and adds a distinguishing runtime block. It clearly differentiates from siblings like get_project_settings and get_project_files by describing the metadata + runtime status scope.

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 instructs to use as the first call before driving a running project, and explains the optional projectPath behavior ('Omit projectPath for just the Godot version and runtime status'). This gives clear when-to-use guidance and implies when not to use it (when you need files/settings, use siblings).

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