Skip to main content
Glama

mgba_read32

Read a 32-bit unsigned value from a 4-byte aligned GBA memory address. Useful for inspecting emulator memory state.

Instructions

Read an unsigned 32-bit little-endian value from a GBA memory address. Address should be 4-byte aligned.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
addressYesGBA memory address (must be 4-byte aligned)

Implementation Reference

  • The handler case for mgba_read32: calls the mGBA bridge's 'read32' RPC method with the address parameter and formats the result as hex.
    case "mgba_read32": {
      const v = await mgba.call<number>("read32", { address: p.address });
      return ok(`0x${(p.address as number).toString(16).toUpperCase()}: ${formatHex(v)}`);
    }
  • The tool definition with name 'mgba_read32', description, and input schema requiring an integer address.
      name: "mgba_read32",
      description: "Read an unsigned 32-bit little-endian value from a GBA memory address. Address should be 4-byte aligned.",
      inputSchema: {
        type: "object",
        required: ["address"],
        properties: {
          address: { type: "integer", description: "GBA memory address (must be 4-byte aligned)" },
        },
      },
    },
  • src/tools.ts:258-411 (registration)
    The registration function that wires up the tool definitions (TOOLS array) and the CallToolRequestSchema handler (which contains all switch cases including mgba_read32) to the MCP server.
    export function registerTools(server: Server, mgba: MgbaClient): void {
      server.setRequestHandler(ListToolsRequestSchema, async () => ({ tools: TOOLS }));
    
      server.setRequestHandler(CallToolRequestSchema, async (req) => {
        const { name, arguments: args = {} } = req.params;
        const p = args as Record<string, unknown>;
    
        switch (name) {
          case "mgba_ping": {
            const r = await mgba.call<string>("ping");
            return ok(r);
          }
    
          case "mgba_get_info": {
            const r = await mgba.call<{
              title?: string;
              code?: string;
              frame?: number;
              platform?: number | string;
              capabilities?: Record<string, boolean>;
            }>("get_info");
            const lines = [
              `Title:    ${r.title ?? "(unavailable)"}`,
              `Code:     ${r.code ?? "(unavailable)"}`,
              `Platform: ${r.platform ?? "(unavailable)"}`,
              `Frame:    ${r.frame ?? "(unavailable)"}`,
            ];
            if (r.capabilities) {
              const present = Object.entries(r.capabilities).filter(([, v]) => v).map(([k]) => k);
              const missing = Object.entries(r.capabilities).filter(([, v]) => !v).map(([k]) => k);
              lines.push("");
              lines.push(`Capabilities present: ${present.length ? present.join(", ") : "(none)"}`);
              if (missing.length) lines.push(`Missing on this build: ${missing.join(", ")}`);
            }
            return ok(lines.join("\n"));
          }
    
          case "mgba_read8": {
            const v = await mgba.call<number>("read8", { address: p.address });
            return ok(`0x${(p.address as number).toString(16).toUpperCase()}: ${formatHex(v)}`);
          }
    
          case "mgba_read16": {
            const v = await mgba.call<number>("read16", { address: p.address });
            return ok(`0x${(p.address as number).toString(16).toUpperCase()}: ${formatHex(v)}`);
          }
    
          case "mgba_read32": {
            const v = await mgba.call<number>("read32", { address: p.address });
            return ok(`0x${(p.address as number).toString(16).toUpperCase()}: ${formatHex(v)}`);
          }
    
          case "mgba_write8": {
            await mgba.call("write8", { address: p.address, value: p.value });
            return ok(`Wrote ${formatHex(p.value)} → 0x${(p.address as number).toString(16).toUpperCase()}`);
          }
    
          case "mgba_write16": {
            await mgba.call("write16", { address: p.address, value: p.value });
            return ok(`Wrote ${formatHex(p.value)} → 0x${(p.address as number).toString(16).toUpperCase()}`);
          }
    
          case "mgba_write32": {
            await mgba.call("write32", { address: p.address, value: p.value });
            return ok(`Wrote ${formatHex(p.value)} → 0x${(p.address as number).toString(16).toUpperCase()}`);
          }
    
          case "mgba_read_range": {
            const bytes = await mgba.call<number[]>("read_range", {
              address: p.address,
              length:  p.length,
            });
            const hex = bytes
              .map((b) => b.toString(16).padStart(2, "0").toUpperCase())
              .join(" ");
            const addr = (p.address as number).toString(16).toUpperCase();
            return ok(`0x${addr} [${bytes.length} bytes]:\n${hex}`);
          }
    
          case "mgba_write_range": {
            const r = await mgba.call<{ written: number }>("write_range", {
              address: p.address,
              bytes:   p.bytes,
            });
            const addr = (p.address as number).toString(16).toUpperCase();
            return ok(`Wrote ${r.written} bytes → 0x${addr}`);
          }
    
          case "mgba_press_buttons": {
            const r = await mgba.call<{ queued: boolean; queue_size: number }>("press_buttons", {
              buttons:        p.buttons,
              frames:         p.frames         ?? 1,
              release_frames: p.release_frames ?? 1,
            });
            const keys = (p.buttons as string[]).join("+");
            return ok(
              `Queued press: ${keys} ` +
              `(hold ${p.frames ?? 1}f, release ${p.release_frames ?? 1}f). ` +
              `Queue size: ${r.queue_size}`,
            );
          }
    
          case "mgba_advance_frames": {
            const frame = await mgba.call<number>("advance_frames", { count: p.count ?? 1 });
            return ok(`Advanced ${p.count ?? 1} frame(s). Current frame: ${frame}`);
          }
    
          case "mgba_pause": {
            await mgba.call("pause");
            return ok("Emulation paused");
          }
    
          case "mgba_unpause": {
            await mgba.call("unpause");
            return ok("Emulation resumed");
          }
    
          case "mgba_reset": {
            await mgba.call("reset");
            return ok("ROM reset");
          }
    
          case "mgba_screenshot": {
            const path = await mgba.call<string>("screenshot", p.path ? { path: p.path } : {});
            return ok(`Screenshot saved: ${path}`);
          }
    
          case "mgba_save_state": {
            if (p.slot === undefined && p.path === undefined) {
              throw new Error("provide either `slot` (0-9) or `path`");
            }
            const r = await mgba.call<{ slot?: number; path?: string }>("save_state", {
              ...(p.slot !== undefined ? { slot: p.slot } : {}),
              ...(p.path !== undefined ? { path: p.path } : {}),
            });
            return ok(r.path ? `Saved state to ${r.path}` : `Saved state to slot ${r.slot}`);
          }
    
          case "mgba_load_state": {
            if (p.slot === undefined && p.path === undefined) {
              throw new Error("provide either `slot` (0-9) or `path`");
            }
            const r = await mgba.call<{ slot?: number; path?: string }>("load_state", {
              ...(p.slot !== undefined ? { slot: p.slot } : {}),
              ...(p.path !== undefined ? { path: p.path } : {}),
            });
            return ok(r.path ? `Loaded state from ${r.path}` : `Loaded state from slot ${r.slot}`);
          }
    
          default:
            throw new Error(`Unknown tool: ${name}`);
        }
      });
    }
Behavior2/5

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

With no annotations provided, the description bears full responsibility for disclosing behavior. It states the read operation and alignment but does not explicitly confirm it is read-only, non-destructive, or what happens on alignment errors. This is minimal disclosure.

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?

Two sentences, no wasted words. The first sentence states the purpose, the second adds a critical constraint. Information is front-loaded and clear.

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?

For a simple read tool with one parameter and no output schema, the description is largely complete: it specifies what is read, the endianness, and alignment. It could mention error handling or confirm non-destructive behavior, but it is sufficient for basic usage.

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 input schema already describes the address parameter and its alignment. The description adds the data type (unsigned 32-bit little-endian) and the value interpretation, providing additional context beyond the schema.

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 verb 'Read' and the specific resource 'unsigned 32-bit little-endian value from a GBA memory address', and includes the alignment constraint. This distinguishes it from siblings like mgba_read16 and mgba_read8.

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

Usage Guidelines4/5

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

The description implies when to use this tool (read 32-bit values) and provides the 4-byte alignment requirement. However, it does not explicitly state when not to use it or mention alternatives like mgba_read8 for 8-bit reads.

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/dmang-dev/mcp-mgba'

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