diff options
| author | sigoden <sigoden@gmail.com> | 2024-07-30 15:09:18 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-30 15:09:18 +0800 |
| commit | 3e8b7b2e4528074594c5c27bea663aec4c517e21 (patch) | |
| tree | 1505949cd4acc1f1e049c48cb87a5846096ca6fa /agents/demo/README.md | |
| parent | 213d1b3fd72d2572050402b6be25cad590a9cb95 (diff) | |
| download | llm-functions-docker-3e8b7b2e4528074594c5c27bea663aec4c517e21.tar.gz | |
refactor: demo agent with `LLM_AGENT_VAR_*` (#82)
Diffstat (limited to 'agents/demo/README.md')
| -rw-r--r-- | agents/demo/README.md | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/agents/demo/README.md b/agents/demo/README.md index ab9831d..856c7ff 100644 --- a/agents/demo/README.md +++ b/agents/demo/README.md @@ -21,21 +21,26 @@ variables: When use define variables, please avoid these built-in variables: -| name | description | example | -| :------------ | :-------------------------------------------- | :----------------------- | -| __os__ | Operating system name | linux | -| __os_family__ | Operating system family | unix | -| __arch__ | System architecture | x86_64 | -| __shell__ | Current user's default shell | bash | -| __locale__ | User's preferred language and region settings | en-US | -| __now__ | Current timestamp in ISO 8601 format | 2024-07-29T08:11:24.367Z | -| __cwd__ | Current working directory | /tmp | - -Variables should be used in the `instructions` field. +| name | description | example | +| :-------------- | :-------------------------------------------- | :----------------------- | +| `__os__` | Operating system name | linux | +| `__os_family__` | Operating system family | unix | +| `__arch__` | System architecture | x86_64 | +| `__shell__` | Current user's default shell | bash | +| `__locale__` | User's preferred language and region settings | en-US | +| `__now__` | Current timestamp in ISO 8601 format | 2024-07-29T08:11:24.367Z | +| `__cwd__` | Current working directory | /tmp | +| `__tools__` | List of agent tools | | + +Variables can be used in the `instructions` and tools script. ```yaml instructions: | - The instructions can inline user defined variables: {{foo}}, {{bar}} and builtin variables {{__shell__}}. + The instructions can access variables {{foo}} and {{bar}}. +``` + +```sh +echo "The tools script can access environment variables $LLM_AGENT_VAR_FOO and $LLM_AGENT_VAR_BAR" ``` ### documents @@ -53,8 +58,6 @@ documents: The tool script implements agent-specific tools. -> You only need one of the `tools.sh`, `tools.js`, or `tools.py`. - ## tools.txt The `tools.txt` file enables tool reuse from the `/tools` folder in this project. |