Skip to main content
Glama

get_debug_output

Retrieve real-time debug information and error logs from the Godot game engine to identify and resolve issues during development.

Instructions

Get the current debug output and errors

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function that executes the get_debug_output tool logic. It checks if there is an active Godot process and returns its captured output and errors as JSON, or an error message if no process is running.
    private async handleGetDebugOutput() {
      if (!this.activeProcess) {
        return this.createErrorResponse(
          'No active Godot process.',
          [
            'Use run_project to start a Godot project first',
            'Check if the Godot process crashed unexpectedly',
          ]
        );
      }
    
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(
              {
                output: this.activeProcess.output,
                errors: this.activeProcess.errors,
              },
              null,
              2
            ),
          },
        ],
      };
    }
  • The input schema for the get_debug_output tool, specifying an empty object with no required properties.
    inputSchema: {
      type: 'object',
      properties: {},
      required: [],
    },
  • src/index.ts:702-709 (registration)
    The tool registration entry in the list_tools response, defining the name, description, and schema for get_debug_output.
      name: 'get_debug_output',
      description: 'Get the current debug output and errors',
      inputSchema: {
        type: 'object',
        properties: {},
        required: [],
      },
    },
  • src/index.ts:939-940 (registration)
    The switch case in the CallToolRequestSchema handler that routes calls to get_debug_output to its handler function.
      return await this.handleGetDebugOutput();
    case 'stop_project':
  • Helper interface defining the GodotProcess object used to store the process, output, and errors accessed by the get_debug_output handler.
    interface GodotProcess {
      process: any;
      output: string[];
      errors: string[];
    }
Behavior2/5

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

With no annotations, the description carries full burden but only states what the tool does, not how it behaves. It doesn't disclose if this is a read-only operation, requires specific permissions, returns real-time or cached data, has rate limits, or what format the output takes (e.g., text, JSON). This leaves significant behavioral gaps for a tool that likely interacts with a debug system.

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, efficient sentence with no wasted words. It's front-loaded with the core action ('Get') and resource ('debug output and errors'), making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's likely complexity (interacting with debug systems) and lack of annotations or output schema, the description is incomplete. It doesn't explain what 'debug output' entails, how errors are formatted, or what the return value looks like, which is critical for an agent to use it effectively in a Godot project context.

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?

The tool has 0 parameters, and schema description coverage is 100%, so there are no parameters to document. The description doesn't need to add parameter semantics, and a baseline of 4 is appropriate since there's nothing to compensate for, though it doesn't explicitly state 'no parameters required'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool's purpose as retrieving debug output and errors, which is clear but generic. It doesn't specify what type of debug output (e.g., from Godot engine, project, or system) or distinguish it from sibling tools like get_project_info or get_godot_version, which might also provide diagnostic information.

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?

No guidance is provided on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a running project), exclusions, or how it differs from sibling tools that might offer related debugging or project information, leaving the agent to guess based on context.

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

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