Schemas and Extension

Start typing here...

Extension metadata and schemas

Your plugin must provide an extension.json describing itself. The JSON Schema is shipped with the API in remote-dev resources.

Schema: plugin-api/remote-dev/src/main/resources/extension.schema.json
Dependencies Schema: plugin-api/remote-dev/src/main/resources/dependencies.schema.json

extension.json fields

id: unique plugin id (should match Marketplace id)
version: SemVer
meta: readableName, description, vendor, url; optional backgroundColors (start, top, end)
apiVersion: target Toolbox plugin API version (SemVer)
compatibleVersionRange: { from, to? } Toolbox App compatibility

Check the following example of a minimal JSON file:

    {
        "id": "com.example.toolbox.myplugin",
        "version": "1.0.0",
        "meta": {
            "readableName": "My Plugin",
            "description": "Remote Dev integration",
            "vendor": "Example Inc.",
            "url": "https://example.com/myplugin"
        },
        "apiVersion": "1.6.0"
    }
            

dependencies.json

Provide third-party dependencies used by your plugin if required by internal compliance:

    [
        {
            "name": "OkHttp",
            "version": "4.12.0",
            "url": "https://square.github.io/okhttp/",
            "license": "Apache-2.0",
            "licenseUrl": "https://www.apache.org/licenses/LICENSE-2.0"
        }
    ]
            

11 September 2025