shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add available imports section to custom tools docs

Browse Source
This commit is contained in:
Mario Zechner
2025-12-17 16:41:55 +01:00
parent 909989066a
commit ed8ee03e22
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/coding-agent/docs/custom-tools.md
View File

@@ -44,6 +44,19 @@ The tool is automatically discovered and available in your next pi session.
**Reserved names:** Custom tools cannot use built-in tool names (`read`, `write`, `edit`, `bash`, `grep`, `find`, `ls`).
## Available Imports
Custom tools can import from these packages (automatically resolved by pi):
| Package | Purpose |
|---------|---------|
| `@sinclair/typebox` | Schema definitions (`Type.Object`, `Type.String`, etc.) |
| `@mariozechner/pi-coding-agent` | Types (`CustomToolFactory`, `ToolSessionEvent`, etc.) |
| `@mariozechner/pi-ai` | AI utilities (`StringEnum` for Google-compatible enums) |
| `@mariozechner/pi-tui` | TUI components (`Text`, `Box`, etc. for custom rendering) |
Node.js built-in modules (`node:fs`, `node:path`, etc.) are also available.
## Tool Definition
```typescript