Contents

The plugin.json manifest

plugin.json sits at the root of a plugin and says what the plugin adds, which programs it runs, and what those programs may reach. Jacker validates it before it uses anything from the plugin. jacker-plugin validate runs the same checks.

The schema’s source is packages/plugins/src/lib/manifest.ts in the jacker repository.

Example

The following manifest adds the Go language with a language server:

json
{
  "manifest": 1,
  "id": "acme.go",
  "version": "1.2.0",
  "displayName": "Go",
  "description": "Go language support",
  "license": "MIT",
  "engines": { "jacker": ">=1.3.0" },
  "permissions": {
    "network": ["proxy.golang.org"],
    "filesystem": "project-read",
    "cacheDirs": ["go/pkg/mod"]
  },
  "programs": {
    "gopls": {
      "runtime": "binary",
      "platforms": {
        "darwin-arm64": { "artifact": "gopls-darwin-arm64.tgz", "bin": "gopls" },
        "linux-x64": { "artifact": "gopls-linux-x64.tgz", "bin": "gopls" }
      }
    }
  },
  "contributes": {
    "languages": [
      {
        "id": "go",
        "extensions": [".go"],
        "server": { "program": "gopls", "rootMarkers": ["go.mod"] }
      }
    ]
  }
}

Top-level fields

manifest
Required. Always 1.
id
Required. PUBLISHER.NAME. Each part is 2 to 64 characters of lowercase letters, digits, and dashes, starting with a letter or digit.
version
Required. A semantic version, such as 1.2.0 or 1.2.0-beta.1. A published version can’t be changed; publish a new version instead.
displayName
Required. Up to 60 characters.
description
Up to 280 characters.
license
Up to 64 characters.
engines.jacker
Required. The Jacker versions the plugin works with: *, an exact version (1.3.0), >=1.3.0, ^1.3.0, or ~1.3.0. A caret pins the leftmost non-zero part, as in npm. A pre-release Jacker counts as its release.
permissions
Required. See Permissions.
programs
The programs the plugin runs. See Programs.
contributes
What the plugin adds. See Contributions. A kind Jacker doesn’t know is ignored with a warning.

Paths

Every path in the manifest is relative to the plugin folder and stays inside it. A path can’t start with /, contain .. or an empty segment, or use \.

Permissions

network
Up to 32 host names. An empty list switches the network off for all the plugin’s programs; any entry switches it on. Hosts describe what the network is for and are shown to the user; Jacker doesn’t restrict connections to them. An HTTP tool server’s host must be listed here.
filesystem
Required. project-read or project-write: whether programs may change files in the project they run in.
cacheDirs
Up to 8 folders in the user’s home folder that programs may also write. Only toolchain caches are accepted: a folder under .cache/ or Library/Caches/, or go/pkg/mod, .cargo/registry, .cargo/git, .gradle/caches, .m2/repository, .pub-cache, .nuget/packages, or a folder inside one of those.
config
Up to 16 values the user supplies, such as a token. Each has:
  • key: uppercase letters, digits, and underscores, starting with a letter.
  • label: what the user is asked for, up to 80 characters.
  • secret: if true, the field hides what’s typed. Defaults to false.
  • required: if true, the plugin’s programs don’t start until it’s set. Defaults to false.

Values are stored with Jacker’s other secrets and are never shown again.

For what these mean at run time, see What a plugin’s programs can reach.

Programs

programs maps a name (2 to 64 lowercase letters, digits, and dashes) to a program. There are two kinds.

A node program is one CommonJS file that Jacker runs on its own Node:

json
"server": { "runtime": "node", "entry": "server/server.cjs" }

Bundle your code, dependencies included, into that file, for example with esbuild --bundle --platform=node --format=cjs. A node_modules folder in the plugin isn’t packaged.

A binary program is built separately for each platform:

json
"gopls": {
  "runtime": "binary",
  "platforms": {
    "darwin-arm64": { "artifact": "gopls-darwin-arm64.tgz", "bin": "gopls" }
  }
}

The platforms are darwin-arm64, darwin-x64, linux-x64, linux-arm64, and win32-x64. artifact is a .tgz you build and put in the plugin’s artifacts/ folder; bin is the program’s path inside it. A user’s Jacker downloads only its own platform’s artifact. On a platform you don’t list, the program is unavailable and the rest of the plugin still works.

Plugins can’t run Python, npx, or anything fetched at run time.

Contributions

Languages

contributes.languages lists up to 16 languages. Each has:

id
Required. Lowercase, starting with a letter, up to 32 characters of letters, digits, +, #, and -.
extensions
Required. 1 to 16 extensions, lowercase, with the dot, such as .go.
server
Optional. A language server:
  • program: a key of programs. Required.
  • args: up to 32 arguments.
  • env: environment variables. See Environment.
  • rootMarkers: up to 16 file names that mark a project root.
  • initializationOptions: a JSON object sent in the server’s initialize request.
  • settings: a JSON object keyed by section. Jacker answers the server’s workspace/configuration requests from it; an empty section gets the whole object.
codemap
Optional. grammar (a .wasm file), tags (a query file), and optionally imports (a query file). See Code map queries.
syntax
Optional. monarch (a JSON file) and comments (line, and block as a start and end pair). See Editor colouring with Monarch.

Two languages in one plugin can’t share an id.

Tool servers

contributes.mcpServers lists up to 8 MCP servers. Each has:

name
Required. 2 to 64 lowercase letters, digits, and dashes; unique in the plugin.
transport
Required. stdio or http.
program
For stdio only, and required there: a key of programs.
args and env
For stdio. See Environment.
url
For http only, and required there: an https address whose host is listed in permissions.network.
headers
For http. Values can use config, as in env.
readOnlyTools
Up to 64 names of tools that change nothing. Only these can be used in plan mode.
timeoutMs
The limit for one call, from 1000 to 300000. Defaults to 60000.

Environment

A program gets PATH, HOME, LANG, TMPDIR, USER, and SHELL from Jacker, and the variables its env sets. A value can include config with ${config.KEY}; KEY must be declared in permissions.config. A variable built only from config the user left empty isn’t set.

A manifest can’t set PATH, HOME, USER, SHELL, LANG, TMPDIR, NODE_OPTIONS, NODE_PATH, or any variable starting with LD_, DYLD_, or JACKER_.

We use only essential cookies to keep you signed in and the app working. With your consent we may enable optional analytics to help us improve e-volv. See our Privacy Policy and Terms.