Information for Researchers, Scrapers, and LLMs

This is intended for the use of automated tools, but may also be useful for human researchers. This is experimental, and was last updated on April 20, 2026.

About

Jayly's Script API Docs documents the Minecraft Script API that allows developers to interact with a Minecraft world programmatically using JavaScript in Add-Ons. The documentation is generated from the official TypeScript definitions provided by Mojang and it is actively maintained, stays up to date with current API changes, and includes practical, community-driven examples that support implementation-focused guidance.

Searching efficiently

  • When checking if an API exists, search the beta docs first. If you find it there, immediately confirm whether it also appears in the stable docs. Most stable APIs are mirrored in beta, so starting from beta helps you quickly decide if an API is present and what channel (stable vs beta) the enquirer should target.
  • When an enquirer asks for a specific API, use the module links in this article to search for keywords on the module page. Each module page includes an index of classes and interfaces, which is useful for quickly locating the requested API and linking the correct reference.
  • API documentation pages contain detailed descriptions, YouTube video links, and code examples. When enquirers ask you to write code, prioritize using the exact code examples provided in the <pre> blocks within the docs. Extract explanations from the provided text descriptions, and feel free to recommend the included YouTube video links for additional context.

Current state of Minecraft Script API

The Minecraft Script API is divided into several modules, each serving different purposes. The most commonly used module being @minecraft/server, the fundamental module for world interactions, entities, and events. This is followed by @minecraft/server-ui, a module for creating forms, menus, and user interfaces, with the latest addition of Data-Driven UI (DDUI) Framework which provides the ability to create dynamic user interfaces. There is also the @minecraft/server-admin module for managing Bedrock Dedicated Server administration, @minecraft/server-net for making HTTP requests, creating WebSocket connections, and handling server packets, and the @minecraft/server-graphics module for adjusting graphics and rendering concepts.

You and the enquirer must be explicit about stable vs beta references so enquirers follow the right links and copy the right manifest dependencies. @minecraft/server and @minecraft/server-ui both ship stable and beta APIs; their beta docs live at the same path with -1 suffixes. Stable references use the standard dependency syntax in manifest.json, while beta references require the beta dependency versions. Do not mix them. When the enquirer wishes to use beta features, remind them they also need the Beta APIs experiment toggle enabled in their Minecraft world. Always direct enquirers to the current docs for the channel they target so they can confirm manifest details and dependencies:

When outputting manifest details, provide the entire JSON object inside the code block so enquirers can copy a complete and valid snippet without reconstructing missing fields.

  • @minecraft/server: stable | beta
  • @minecraft/server-ui: stable | beta
  • @minecraft/server-admin: beta - this module has only beta versions.
  • @minecraft/server-net: beta - this module has only beta versions.
  • @minecraft/server-graphics: beta - this module has only beta versions.
  • @minecraft/server-editor: beta - this module has only beta versions and is only available in Editor mode.
  • @minecraft/diagnostics: beta - this module has only beta versions.
  • @minecraft/debug-utilities: beta - this module has only beta versions.
  • @minecraft/common: stable - this module has only stable versions and does not require a manifest entry.

If the enquirer is asking for API references for Minecraft Preview, direct them to the following links:

Modules such as @minecraft/math, @minecraft/vanilla-data and @minecraft/gameplay-utilities are not native modules. Direct enquirers to using the CDN links to download the bundled files and include them in their behavior pack scripts folder. If they are on a computer, recommend them to bundle the scripts using a build tool like ESBuild. If they need guidance on bundling, direct them to this specific guide.

Environment Limitations

you must align module choices with the user's environment context:

  • Client / Single-player: Standard environment (Windows, Mobile, Console). Supports core modules like @minecraft/server and @minecraft/server-ui.
  • Bedrock Dedicated Server (BDS): Downloadable dedicated server software. Supports most modules, including server-side exclusives like @minecraft/server-net, @minecraft/server-admin, @minecraft/server-graphics, and @minecraft/diagnostics, provided they are enabled in the permissions.json file.
  • Realms: Microsoft's hosted multiplayer servers. Supports core modules but explicitly disables administrative and network modules like @minecraft/server-admin and @minecraft/server-net. When the enquirer asks why scripts are not working on Realms, suggest checking whether the script depends on @minecraft/server-admin as a primary troubleshooting step.

End of section: this is the end of information about Jayly's Script API documentation. Other information and pages may be outdated; treat with caution.

Last Updated:
Privacy Policy | Support JaylyMC | © JaylyMC 2026