Using Plugins
Plugins let you extend Atlas beyond its built-in features. They’re small web applications that run locally on your machine and connect to Atlas through a local HTTP server.
Enabling the Plugin Server
Section titled “Enabling the Plugin Server”Before you can use plugins, you need to enable the plugin server:
- Go to Settings > Plugins
- Toggle Plugin Server on
- The server starts on port 21847 by default (you can change this in settings)
The plugin server is a local-only HTTP server that runs on your machine. It’s not accessible from the internet.
Installing Plugins
Section titled “Installing Plugins”Plugins can be installed from two places:
- From the Marketplace: Browse and install directly from the Marketplace tab in the Plugins panel
- Manually: Place the plugin folder in the plugins directory and click Reload Plugins
Managing Installed Plugins
Section titled “Managing Installed Plugins”Your installed plugins appear in the Plugins list in Settings > Plugins. From here you can:
- Enable or disable individual plugins with a toggle
- View plugin details: version, author, description, and permissions
- Regenerate the plugin secret if a plugin’s credentials are compromised
Disabling a plugin stops it from running but keeps it installed. You can re-enable it at any time.
Plugin Permissions
Section titled “Plugin Permissions”Each plugin declares what it needs access to. When you install or enable a plugin, you’ll see which permissions it’s requesting:
| Permission | What It Allows |
|---|---|
read_vault | Read files and notes from your vault |
write_vault | Create, edit, and delete files in your vault |
network | Make outbound network requests |
execute_tools | Call Atlas agent tools programmatically |
ui_components | Render custom UI panels inside Atlas |
config | Read (but not write) Atlas configuration |
A plugin that only needs read_vault and ui_components is lower risk than one requesting write_vault and network. Review permissions with that in mind.
If a Plugin Causes Problems
Section titled “If a Plugin Causes Problems”If a plugin is behaving unexpectedly:
- Disable it in Settings > Plugins
- Check the plugin’s documentation or repository for known issues
- If you think it’s corrupting vault files, check the file diff preview (enable in Settings > Privacy)
To browse available plugins, see Plugin Marketplace. To build your own plugin, see Building Plugins.