Tools
Installation
Install all tools
From npm (recommended for stable releases):Install individual tools
Cherry-pick specific tools from the repository via GitHub:Install from local checkout (development)
Usage
After installing, add tools to your agents inconfig.json5:
path or target. Add a tools.<name> entry only for custom config:
Access Control
Every tool supports fine-grained permission scoping viaconfig:
Per-Agent Overrides
Use per-agenttoolConfigs to deep-merge overrides with the base tool config:
Managing Tools
Documentation Structure
Each tool has two documentation files:Development
Prerequisites
- Node.js ≥ 22
- pnpm
Setup
Working Locally Against Beige
devDependencies references the published @matthias-hausberger/beige npm package so the project builds on any machine without extra setup. When you also have the beige repository checked out as a sibling directory (../beige), pnpm’s overrides block in package.json automatically redirects the dependency to that local copy, letting you test against unreleased changes.
beige directory, remove or comment out the pnpm.overrides entry in package.json before running pnpm install, or pnpm will error because the file:../beige path does not exist:
tools/ take effect on the next gateway restart.
Running Tests
Adding a New Tool
- Create
tools/<name>/withtool.json,package.json,index.ts,README.md,SKILL.md - Write tests in
tools/<name>/__tests__/ - If the tool has npm dependencies, add them to
tools/<name>/package.jsonunderdependencies
package.json so it can be installed individually via GitHub. For tools with no runtime dependencies, the package.json just needs name and type:
Publishing
files field in the root package.json controls what goes into the npm tarball. Only tool source files are included — tests, scripts, and dev config are excluded.
