Skip to content

Commit 61c84f6

Browse files
55N10ECodex-Agent
authored andcommitted
docs(tools_configuration): document file, agent, hardware, message, reaction, and load_image tools
1 parent 3685127 commit 61c84f6

1 file changed

Lines changed: 132 additions & 0 deletions

File tree

docs/reference/tools_configuration.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,136 @@ The skills tool configures skill discovery and installation via registries like
575575
}
576576
```
577577

578+
## File Tools
579+
580+
PicoClaw provides several file operation tools for reading, writing, and managing files within the agent workspace.
581+
582+
### `read_file`
583+
584+
Read file contents into the agent context.
585+
586+
| Config | Type | Default | Description |
587+
|--------|------|---------|-------------|
588+
| `enabled` | bool | true | Enable the read_file tool |
589+
| `mode` | string | `"bytes"` | Read mode (`"bytes"` or `"lines"`) |
590+
| `max_read_file_size` | int | 65536 | Maximum file size to read, in bytes |
591+
592+
### `write_file`
593+
594+
Write content to a file in the workspace.
595+
596+
| Config | Type | Default | Description |
597+
|--------|------|---------|-------------|
598+
| `enabled` | bool | true | Enable the write_file tool |
599+
600+
### `edit_file`
601+
602+
Edit an existing file by replacing old text with new text.
603+
604+
| Config | Type | Default | Description |
605+
|--------|------|---------|-------------|
606+
| `enabled` | bool | true | Enable the edit_file tool |
607+
608+
### `append_file`
609+
610+
Append content to the end of a file.
611+
612+
| Config | Type | Default | Description |
613+
|--------|------|---------|-------------|
614+
| `enabled` | bool | true | Enable the append_file tool |
615+
616+
### `list_dir`
617+
618+
List files and directories in a path.
619+
620+
| Config | Type | Default | Description |
621+
|--------|------|---------|-------------|
622+
| `enabled` | bool | true | Enable the list_dir tool |
623+
624+
### `load_image`
625+
626+
Load a local image file into the agent context. The image is stored in the media store and a `media://` reference is returned to the LLM.
627+
628+
| Config | Type | Default | Description |
629+
|--------|------|---------|-------------|
630+
| `enabled` | bool | true | Enable the load_image tool |
631+
632+
### `send_file`
633+
634+
Send a local file to the user on the current chat channel.
635+
636+
| Config | Type | Default | Description |
637+
|--------|------|---------|-------------|
638+
| `enabled` | bool | true | Enable the send_file tool |
639+
640+
### `message`
641+
642+
Send a message to the user on a chat channel.
643+
644+
| Config | Type | Default | Description |
645+
|--------|------|---------|-------------|
646+
| `enabled` | bool | true | Enable the message tool |
647+
648+
### `reaction`
649+
650+
Add a reaction (emoji) to a message. Defaults to the current inbound message when `message_id` is omitted.
651+
652+
| Config | Type | Default | Description |
653+
|--------|------|---------|-------------|
654+
| `enabled` | bool | true | Enable the reaction tool |
655+
656+
## Agent Tools
657+
658+
### `spawn`
659+
660+
Spawn a subagent to handle a task.
661+
662+
| Config | Type | Default | Description |
663+
|--------|------|---------|-------------|
664+
| `enabled` | bool | true | Enable the spawn tool |
665+
666+
### `spawn_status`
667+
668+
Check the status of a spawned subagent.
669+
670+
| Config | Type | Default | Description |
671+
|--------|------|---------|-------------|
672+
| `enabled` | bool | false | Enable the spawn_status tool |
673+
674+
### `subagent`
675+
676+
Execute a subagent task synchronously.
677+
678+
| Config | Type | Default | Description |
679+
|--------|------|---------|-------------|
680+
| `enabled` | bool | true | Enable the subagent tool |
681+
682+
## Hardware Tools
683+
684+
### `i2c`
685+
686+
Interact with I²C devices (Linux only).
687+
688+
| Config | Type | Default | Description |
689+
|--------|------|---------|-------------|
690+
| `enabled` | bool | false | Enable the I²C tool |
691+
692+
### `spi`
693+
694+
Interact with SPI devices (Linux only).
695+
696+
| Config | Type | Default | Description |
697+
|--------|------|---------|-------------|
698+
| `enabled` | bool | false | Enable the SPI tool |
699+
700+
### `serial`
701+
702+
Interact with serial ports.
703+
704+
| Config | Type | Default | Description |
705+
|--------|------|---------|-------------|
706+
| `enabled` | bool | false | Enable the serial tool |
707+
578708
## Environment Variables
579709

580710
All configuration options can be overridden via environment variables with the format `PICOCLAW_TOOLS_<SECTION>_<KEY>`:
@@ -587,6 +717,8 @@ For example:
587717
- `PICOCLAW_TOOLS_CRON_EXEC_TIMEOUT_MINUTES=10`
588718
- `PICOCLAW_TOOLS_MCP_ENABLED=true`
589719
- `PICOCLAW_TOOLS_MCP_MAX_INLINE_TEXT_CHARS=16384`
720+
- `PICOCLAW_TOOLS_LOAD_IMAGE_ENABLED=false`
721+
- `PICOCLAW_TOOLS_REACTION_ENABLED=false`
590722

591723
Note: Nested map-style config (for example `tools.mcp.servers.<name>.*`) is configured in `config.json` rather than
592724
environment variables.

0 commit comments

Comments
 (0)