Skip to main content
Glama

Get class documentation

godot_api_doc
Read-only

Retrieve comprehensive reference documentation for any Godot class, including inheritance, methods, properties, signals, and constants.

Instructions

Return the reference documentation for a Godot class: inheritance, description, methods, properties, signals and constants.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
membersNoInclude methods/properties/signals (off for just the summary).
versionNoGodot version to use, e.g. "4.7", "4.7-stable", "stable"/"latest". Defaults to the project's declared version, then the latest stable release.
class_nameYesExact class name, e.g. "Node2D" (case-sensitive).
project_rootNoPath to the Godot project root (folder containing project.godot). Defaults to $GODOT_PROJECT_ROOT or an upward search from the working directory.
response_formatNoOutput format. "markdown" is human-readable; "json" is structured.markdown
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true. The description confirms it returns documentation, which is consistent. However, it adds no additional behavioral context beyond what the annotations provide, such as how the data is fetched or any limitations.

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 a single, well-structured sentence that immediately conveys the tool's purpose. No extraneous words or information.

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 no output schema, the description adequately lists the documentation sections returned. It does not mention output format options (covered in params) or case sensitivity (also in params). Overall sufficient for a read-only doc tool.

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?

All 5 parameters have schema descriptions (100% coverage), so the schema already explains parameter meaning. The description adds no further parameter details; it only lists output sections. A baseline of 3 is appropriate.

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 tool returns reference documentation for a Godot class, explicitly listing the included sections (inheritance, description, methods, properties, signals, constants). This distinguishes it from sibling tools like godot_api_search and godot_eval.

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 does not provide explicit guidance on when to use this tool versus alternatives. While the name and context imply it's for full documentation, there are no when-to-use or when-not-to-use instructions.

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/Fulviuus/godot-mcp'

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