titor/mimiclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(search): add Tavily setup and CLI usage examples

Browse Source 
Signed-off-by: Asklv <boironic@gmail.com>
This commit is contained in:
Asklv
2026-02-18 19:16:00 +08:00
parent a7b3d67ecb
commit b75370a290
3 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -130,6 +130,7 @@ Edit `main/mimi_secrets.h`:
#define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx"
#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" or "openai" #define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" or "openai"
#define MIMI_SECRET_SEARCH_KEY "" // optional: Brave Search API key #define MIMI_SECRET_SEARCH_KEY "" // optional: Brave Search API key
#define MIMI_SECRET_TAVILY_KEY "" // optional: Tavily API key (preferred)
#define MIMI_SECRET_PROXY_HOST "" // optional: e.g. "10.0.0.1" #define MIMI_SECRET_PROXY_HOST "" // optional: e.g. "10.0.0.1"
#define MIMI_SECRET_PROXY_PORT "" // optional: e.g. "7897" #define MIMI_SECRET_PROXY_PORT "" // optional: e.g. "7897"
``` ```
@@ -173,6 +174,7 @@ mimi> set_model gpt-4o # change LLM model
mimi> set_proxy 127.0.0.1 7897 # set HTTP proxy mimi> set_proxy 127.0.0.1 7897 # set HTTP proxy
mimi> clear_proxy # remove proxy mimi> clear_proxy # remove proxy
mimi> set_search_key BSA... # set Brave Search API key mimi> set_search_key BSA... # set Brave Search API key
mimi> set_tavily_key tvly-... # set Tavily API key (preferred)
mimi> config_show # show all config (masked) mimi> config_show # show all config (masked)
mimi> config_reset # clear NVS, revert to build-time defaults mimi> config_reset # clear NVS, revert to build-time defaults
``` ```
@@ -252,13 +254,13 @@ MimiClaw supports tool calling for both Anthropic and OpenAI — the LLM can cal
| Tool | Description | | Tool | Description |
|------|-------------| |------|-------------|
| `web_search` | Search the web via Brave Search API for current information | | `web_search` | Search the web via Tavily (preferred) or Brave for current information |
| `get_current_time` | Fetch current date/time via HTTP and set the system clock | | `get_current_time` | Fetch current date/time via HTTP and set the system clock |
| `cron_add` | Schedule a recurring or one-shot task (the LLM creates cron jobs on its own) | | `cron_add` | Schedule a recurring or one-shot task (the LLM creates cron jobs on its own) |
| `cron_list` | List all scheduled cron jobs | | `cron_list` | List all scheduled cron jobs |
| `cron_remove` | Remove a cron job by ID | | `cron_remove` | Remove a cron job by ID |
To enable web search, set a [Brave Search API key](https://brave.com/search/api/) via `MIMI_SECRET_SEARCH_KEY` in `mimi_secrets.h`. To enable web search, set a [Tavily API key](https://app.tavily.com/home) via `MIMI_SECRET_TAVILY_KEY` (preferred), or a [Brave Search API key](https://brave.com/search/api/) via `MIMI_SECRET_SEARCH_KEY` in `mimi_secrets.h`.
## Cron Tasks ## Cron Tasks

6
README_CN.md
View File

@@ -130,6 +130,7 @@ cp main/mimi_secrets.h.example main/mimi_secrets.h
#define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx"
#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" 或 "openai" #define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" 或 "openai"
#define MIMI_SECRET_SEARCH_KEY "" // 可选：Brave Search API key #define MIMI_SECRET_SEARCH_KEY "" // 可选：Brave Search API key
#define MIMI_SECRET_TAVILY_KEY "" // 可选：Tavily API key（优先）
#define MIMI_SECRET_PROXY_HOST "10.0.0.1" // 可选：代理地址 #define MIMI_SECRET_PROXY_HOST "10.0.0.1" // 可选：代理地址
#define MIMI_SECRET_PROXY_PORT "7897" // 可选：代理端口 #define MIMI_SECRET_PROXY_PORT "7897" // 可选：代理端口
``` ```
@@ -188,6 +189,7 @@ mimi> set_model gpt-4o # 换模型
mimi> set_proxy 192.168.1.83 7897 # 设置代理 mimi> set_proxy 192.168.1.83 7897 # 设置代理
mimi> clear_proxy # 清除代理 mimi> clear_proxy # 清除代理
mimi> set_search_key BSA... # 设置 Brave Search API Key mimi> set_search_key BSA... # 设置 Brave Search API Key
mimi> set_tavily_key tvly-... # 设置 Tavily API Key（优先）
mimi> config_show # 查看所有配置（脱敏显示） mimi> config_show # 查看所有配置（脱敏显示）
mimi> config_reset # 清除 NVS，恢复编译时默认值 mimi> config_reset # 清除 NVS，恢复编译时默认值
``` ```
@@ -267,13 +269,13 @@ MimiClaw 同时支持 Anthropic 和 OpenAI 的工具调用 — LLM 在对话中
| 工具 | 说明 | | 工具 | 说明 |
|------|------| |------|------|
| `web_search` | 通过 Brave Search API 搜索网页，获取实时信息 | | `web_search` | 通过 Tavily（优先）或 Brave 搜索网页，获取实时信息 |
| `get_current_time` | 通过 HTTP 获取当前日期和时间，并设置系统时钟 | | `get_current_time` | 通过 HTTP 获取当前日期和时间，并设置系统时钟 |
| `cron_add` | 创建定时或一次性任务（LLM 自主创建 cron 任务） | | `cron_add` | 创建定时或一次性任务（LLM 自主创建 cron 任务） |
| `cron_list` | 列出所有已调度的 cron 任务 | | `cron_list` | 列出所有已调度的 cron 任务 |
| `cron_remove` | 按 ID 删除 cron 任务 | | `cron_remove` | 按 ID 删除 cron 任务 |
启用网页搜索需要在 `mimi_secrets.h` 中设置 [Brave Search API key](https://brave.com/search/api/)（`MIMI_SECRET_SEARCH_KEY`）。 启用网页搜索可在 `mimi_secrets.h` 中设置 [Tavily API key](https://app.tavily.com/home)（优先，`MIMI_SECRET_TAVILY_KEY`），或 [Brave Search API key](https://brave.com/search/api/)（`MIMI_SECRET_SEARCH_KEY`）。
## 定时任务（Cron） ## 定时任务（Cron）

6
README_JA.md
View File

@@ -130,6 +130,7 @@ cp main/mimi_secrets.h.example main/mimi_secrets.h
#define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx"
#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" または "openai" #define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" または "openai"
#define MIMI_SECRET_SEARCH_KEY "" // 任意：Brave Search APIキー #define MIMI_SECRET_SEARCH_KEY "" // 任意：Brave Search APIキー
#define MIMI_SECRET_TAVILY_KEY "" // 任意：Tavily APIキー（優先）
#define MIMI_SECRET_PROXY_HOST "" // 任意：例 "10.0.0.1" #define MIMI_SECRET_PROXY_HOST "" // 任意：例 "10.0.0.1"
#define MIMI_SECRET_PROXY_PORT "" // 任意：例 "7897" #define MIMI_SECRET_PROXY_PORT "" // 任意：例 "7897"
``` ```
@@ -173,6 +174,7 @@ mimi> set_model gpt-4o # LLMモデルを変更
mimi> set_proxy 127.0.0.1 7897 # HTTPプロキシを設定 mimi> set_proxy 127.0.0.1 7897 # HTTPプロキシを設定
mimi> clear_proxy # プロキシを削除 mimi> clear_proxy # プロキシを削除
mimi> set_search_key BSA... # Brave Search APIキーを設定 mimi> set_search_key BSA... # Brave Search APIキーを設定
mimi> set_tavily_key tvly-... # Tavily APIキーを設定（優先）
mimi> config_show # 全設定を表示（マスク付き） mimi> config_show # 全設定を表示（マスク付き）
mimi> config_reset # NVSをクリア、ビルド時デフォルトに戻す mimi> config_reset # NVSをクリア、ビルド時デフォルトに戻す
``` ```
@@ -252,13 +254,13 @@ MimiClawはAnthropicとOpenAI両方のツール呼び出しをサポート — L
| ツール | 説明 | | ツール | 説明 |
|--------|------| |--------|------|
| `web_search` | Brave Search APIでウェブ検索、最新情報を取得 | | `web_search` | Tavily（優先）またはBraveでウェブ検索し、最新情報を取得 |
| `get_current_time` | HTTP経由で現在の日時を取得し、システムクロックを設定 | | `get_current_time` | HTTP経由で現在の日時を取得し、システムクロックを設定 |
| `cron_add` | 定期または単発タスクをスケジュール（LLMが自律的にcronジョブを作成） | | `cron_add` | 定期または単発タスクをスケジュール（LLMが自律的にcronジョブを作成） |
| `cron_list` | スケジュール済みのcronジョブを一覧表示 | | `cron_list` | スケジュール済みのcronジョブを一覧表示 |
| `cron_remove` | IDでcronジョブを削除 | | `cron_remove` | IDでcronジョブを削除 |
ウェブ検索を有効にするには、`mimi_secrets.h`で[Brave Search APIキー](https://brave.com/search/api/)（`MIMI_SECRET_SEARCH_KEY`）を設定してください。 ウェブ検索を有効にするには、`mimi_secrets.h`で[Tavily APIキー](https://app.tavily.com/home)（優先、`MIMI_SECRET_TAVILY_KEY`）または[Brave Search APIキー](https://brave.com/search/api/)（`MIMI_SECRET_SEARCH_KEY`）を設定してください。
## Cronタスク ## Cronタスク