Skip to main content
Glama

Read GDScript File

godot_read_script
Read-onlyIdempotent

Reads GDScript (.gd) or text-based resource files from Godot projects to access script content for editing or analysis.

Instructions

Reads the content of a GDScript (.gd) or other text-based resource file.

Args:

  • file_path (string): res:// path e.g. "res://player/player.gd"

Returns: { path: string, content: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_pathYesres:// path to the script file
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=false, covering safety and idempotency. The description adds value by specifying the file types (GDScript and text-based resources) and the return format (path and content), which are not covered by annotations, providing useful behavioral context without contradiction.

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 front-loaded with the core purpose in the first sentence, followed by structured Args and Returns sections. Every sentence adds value without redundancy, making it efficient and easy to parse for an AI agent.

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?

Given the tool's low complexity (single parameter, read-only operation) and rich annotations, the description is mostly complete. It covers purpose, parameters, and return values, but lacks output schema details (e.g., structure of the returned object). However, with annotations handling safety and idempotency, it provides sufficient context for effective use.

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%, with the input schema fully documenting the file_path parameter. The description adds minimal semantics by providing an example path ('res://player/player.gd'), but does not elaborate on format constraints or edge cases beyond what the schema states. This meets the baseline for high schema coverage.

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 clearly states the specific action ('Reads the content') and resource type ('GDScript (.gd) or other text-based resource file'), distinguishing it from siblings like godot_write_script (write) and godot_list_files (list). It precisely defines what the tool does without being vague or tautological.

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?

The description implies usage for reading script files, but does not explicitly state when to use this tool versus alternatives like godot_get_resource (which might handle non-text resources) or godot_run_script (which executes scripts). No explicit exclusions or prerequisites are provided, leaving usage context inferred rather than clearly defined.

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/ricky-yosh/godot-mcp-server'

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