Skip to main content
Glama

Create a new custom event (reusable script)

create_custom_event

Create a reusable custom event script file for GB Studio projects. The script starts empty and can be populated using patch_script, enabling modular behavior in scenes, actors, and triggers.

Instructions

Create a new script resource file under project/scripts/. Custom events are reusable scripts that can be called from scenes/actors/triggers. The script body starts empty — use patch_script with an ownerType: 'customEvent' locator to populate it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name — also seeds the slug.
symbolNoOverride auto-generated GBVM symbol.
descriptionNoHuman-readable description shown in the GB Studio GUI.
Behavior3/5

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

The description discloses that the script body starts empty and that patch_script is needed to populate it. However, with no annotations, it fails to mention potential side effects (e.g., file creation on disk), permissions required, or reversibility, leaving gaps in transparency.

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 two sentences long, front-loads the primary action, and provides essential context without any filler. Every sentence adds value.

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?

The description covers the core behavior (creation, empty body) and hints at the next step (patch_script). It lacks details on error handling (e.g., duplicate names) or return values, but given the simple nature of a create tool and the absence of an output schema, it is largely complete.

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?

The schema description coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond what the schema already provides for 'name' (seeds slug), 'symbol' (override GBVM), and 'description' (GUI display). No additional guidance is offered.

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 creates a new script resource file under project/scripts/ and specifies that custom events are reusable scripts called from scenes, actors, or triggers. The verb 'create' and resource 'custom event' are specific, and the purpose is distinct from sibling tools like delete_custom_event or patch_script.

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 provides explicit context: custom events are reusable scripts, and the script body starts empty, with guidance to use patch_script to populate it. It implies the tool is for creating the initial file, but does not explicitly state when to use it over alternatives or when not to use it, missing exclusions.

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/gbs-toolkit/mcp-server'

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