For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/interfaces/ExtensionOptionalParameters.md.

Interface: ExtensionOptionalParameters

Beta

An interface which defines the set of optional parameters which can be used when calling the registerEditorExtension function

Properties

description?

optional description?: string

Beta

Remarks

An optional text description of the extension being registered. This can be a straight textual description or a string identifier key for a localized string in the extension's resource pack text files. The description is meant to be a very short snappy one-liner which quickly and uniquely identifies the extension The length of the string is capped to 256 characters


notes?

optional notes?: string

Beta

Remarks

Optional notes for the extension being registered. This can be a straight textual description or a string identifier key for a localized string in the extension's resource pack text files. The notes section is meant to convey more detailed information and notes (e.g. a link to the author's website) The length of this string is capped to 1024 characters


toolGroupId?

optional toolGroupId?: string

Beta

Remarks

An optional custom identifier that will be used for all Modal Tools created from the registered extension. The length of the string is capped to 256 characters