On this page
Reference
Develop Mearl Skill plugins
Define a Skill, register its commands, and use Mearl Skill Creator to build and verify a reusable workflow.
Skill and plugin structure
A guidance Skill describes when and how an agent should use existing tools. Add a plugin when the Skill needs its own executable commands or Toolbox interface.
- SKILL.md declares the name and description and explains when to use the Skill, its inputs and outputs, and how to verify the result.
- Use scripts/main.mjs or scripts/main.py as the plugin entry point. The entry point exposes register(app), which declares commands through app.command().
- Keep registration and help free of browser calls and business operations. Put those operations in command handlers with inputs and results that can be represented as JSON.
- For a Toolbox interface, declare toolbox metadata and bundle its resources with the Skill. Share the business logic between the Toolbox and command handlers.
Build a Skill with Mearl Skill Creator
Install Mearl Skill Creator in an agent that can use Mearl. Give it the website, the task, and the expected result. To update a Skill, give it the existing Skill path and the behavior you want to change.
- Describe the task. For example, use mearl-skill-creator to build a report-export Skill for https://example.com/reports that accepts a date range and returns a CSV.
- Have the agent verify the workflow in the intended browser. Use an API for steps that can run through a verified endpoint and browser actions for steps that depend on the page.
- Review the generated SKILL.md and any plugin code. Check that the workflow documents authentication, its inputs and outputs, and how to confirm success.
npx skills add https://github.com/mearlhq/mearl --skill mearl-skill-creator --globalHow a Skill command runs
The Toolbox and agent tools can share the same business operation. The plugin defines its inputs and results, and can call Mearl browser actions when the task needs the current page or sign-in.
- CLI / SDK / MCP or ToolboxSend the command name and its inputs.
- Plugin serviceResolve the installed command and start its task.
- Isolated workerRun the command. Call browser actions as needed.
- CallerReceive the result, such as a list or export file.
Register and verify a local plugin
Register the generated Skill directory and check the CLI help. Substitute your actual directory and registered plugin name for the example values. Verify the inputs and results on the intended browser, then use the same registered name with SDK invokePlugin or MCP plugin_invoke.
npx @mearl/setup plugin ./skills/report-export
mearl report-export --helpDistribute a Skill
Publish the complete skills/<name> directory with its SKILL.md, scripts, and bundled assets. A standard Skills manager can discover the directory. For a Skill that includes a Mearl plugin, use setup plugin install to install the Skill and register its commands together. Use a Preset to distribute a set of Skills, Providers, and capability packages together.