DocsPlugins
Manifest and permissions
Everything a plugin declares lives in manifest.json: what it is, where its UI is, which commands it has, and which permissions it needs.
Example
JSON
{
"schema": 2,
"key": "json-tools",
"name": "JSON Tools",
"version": "1.0.0",
"minHost": "2.2.0",
"description": "Format, minify and stably sort JSON.",
"icon": "{}",
"ui": { "entry": "ui/index.html", "mode": "iframe" },
"permissions": ["clipboard.write", "notify"],
"commands": [
{
"id": "transform",
"title": "Transform JSON",
"description": "Validate JSON, then format, minify or sort it by key.",
"handler": "scripts/transform.mjs",
"params": {
"type": "object",
"properties": {
"text": { "type": "string", "description": "JSON text to process" },
"action": { "type": "string", "enum": ["format", "minify", "sort"] }
},
"required": ["text"]
}
}
],
"contributes": { "tool": { "category": "dev" } }
}Fields
| Field | Description |
|---|---|
schema |
Always 2. |
key |
Globally unique; lowercase letters, digits and hyphens; cannot be changed after creation. |
name / description |
Name and one-line description shown in the market. |
version |
Semantic version; each upload must be higher than the last. |
minHost |
Minimum desktop app version; older clients will not install this version. Use 2.2.0 when you use the __kit__ SDK. |
icon / cover |
Emoji icon; cover is a cover image path inside the package, generated automatically if omitted. |
ui |
UI entry; mode is always iframe. Command-only plugins can omit it. |
permissions |
Permission array (see below), shown to the user item by item at install time. |
commands[] |
Commands. Commands with a handler are registered as AI tools; see Command scripts. |
contributes.tool.category |
Category: efficiency / media / dev / ai / fun. |
Other contributes |
skills (inject prompts into AI), island / panel (need the matching overlay permission), shortcuts (needs the shortcuts permission). |
Permissions
| Permission | Capability | Risk |
|---|---|---|
clipboard.read / clipboard.write | Read / write the clipboard | Medium |
notify | Toast notifications | Low |
ai.chat | Call AI models (uses the user's credits) | Medium |
image.generate / video.generate | Generate images / videos with AI (uses the user's credits) | Medium |
web.search | Web search (uses the user's credits) | Medium |
storage.local | Local KV, 5MB per plugin | Low |
storage.cloud | Cloud KV for the account | Medium |
user.profile | Nickname and avatar (no phone number or token) | Medium |
fs.pick | Read / write files the user picks | Medium |
fs.save | Show a Save As dialog | Low |
fs.workspace | Read / write workspace files | High |
shell.reveal | Reveal files in Finder / Explorer | Low |
shell.open | Open links in the default browser | Low |
shell.openPath | Open local files or apps with the system default | High |
capture.screen | Capture the current screen | Medium |
media.camera / media.microphone | Camera / microphone | High |
overlay.island / overlay.panel | Island / floating panel | Medium |
shortcuts | Register global shortcuts | Medium |
system.stats | Read CPU, memory, battery and network speed | Low |
system.media | Control music playback | Medium |
ocr | Recognize text in images (local first, official cloud as fallback) | Low |
process | Run programs on the user's computer | High |
net.fetch:<domain> | Access a specific domain; declare each domain separately | Medium |
- The UI bridge enforces permissions: an installed plugin calling an undeclared capability gets an error; drafts only get a warning, to make development easier.
- Camera and microphone are refused by the host unless declared.
- Command scripts are not limited by permissions; they run in a full Node environment. If a script uses the network, files or child processes, you must still declare
net.fetch:<domain>,processand so on, so users can confirm at install time and reviewers can check. - Plugins with high-risk permissions need a usage explanation when listed, and reviewers check the code.
Where to store data
| Option | Permission | Notes |
|---|---|---|
| Local KV | storage.local |
5MB per plugin, kept across reinstalls. |
| Cloud KV | storage.cloud |
Isolated per user and plugin; 64KB per item, 1MB total, 60 requests per minute. Writable only after the plugin is listed; use local KV while it is a draft. |
| Your own backend | net.fetch:<domain> |
The install dialog shows the domains accessed; the platform is not responsible for that data. |
Problem with this page?Sent anonymously; your account is not recorded.