docs: add Japanese documents

This commit is contained in:
Ikko Ashimine
2026-03-18 19:13:39 +09:00
parent 8bb16c48c0
commit 5487c0befe
49 changed files with 2417 additions and 2 deletions

28
docs/ja/tools/bash.mdx Normal file
View File

@@ -0,0 +1,28 @@
---
title: bash - ターミナル
description: システムコマンドの実行
---
現在の作業ディレクトリでBashコマンドを実行し、stdoutとstderrを返します。`env_config` で設定されたAPIキーは自動的に環境変数に注入されます。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `command` | string | はい | 実行するコマンド |
| `timeout` | integer | いいえ | タイムアウト(秒) |
## ユースケース
- パッケージや依存関係のインストール
- コードやテストの実行
- アプリケーションやサービスのデプロイNginx設定、プロセス管理など
- システム管理とトラブルシューティング
<Frame>
<img src="https://cdn.link-ai.tech/doc/20260203121008.png" width="800" />
</Frame>

25
docs/ja/tools/browser.mdx Normal file
View File

@@ -0,0 +1,25 @@
---
title: browser - ブラウザ
description: Webページへのアクセスと操作
---
ブラウザを使用してWebページにアクセス・操作します。JavaScriptでレンダリングされる動的ページにも対応しています。
## 依存関係
| 依存関係 | インストールコマンド |
| --- | --- |
| `browser-use` ≥ 0.1.40 | `pip install browser-use` |
| `markdownify` | `pip install markdownify` |
| `playwright` + chromium | `pip install playwright && playwright install chromium` |
## ユースケース
- 特定のURLにアクセスしてページ内容を取得
- Webページの要素を操作クリック、入力など
- デプロイされたWebページの検証
- JSレンダリングが必要な動的コンテンツのスクレイピング
<Note>
ブラウザToolは依存関係が大きいため、不要な場合はインストールを省略できます。軽量なWebコンテンツ取得には、代わりに `web-fetch` Skillをご利用ください。
</Note>

24
docs/ja/tools/edit.mdx Normal file
View File

@@ -0,0 +1,24 @@
---
title: edit - ファイル編集
description: テキスト置換によるファイル編集
---
テキスト置換によるファイル編集を行います。`oldText` が空の場合、ファイル末尾に追記します。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | ファイルパス |
| `oldText` | string | はい | 置換対象の元テキスト(空の場合は追記) |
| `newText` | string | はい | 置換後のテキスト |
## ユースケース
- 設定ファイルの特定パラメータの変更
- コードのバグ修正
- ファイル内の特定位置へのコンテンツ挿入

View File

@@ -0,0 +1,36 @@
---
title: env_config - 環境設定
description: APIキーとシークレットの管理
---
ワークスペースの `.env` ファイルで環境変数APIキーやシークレットを管理し、会話形式で安全に更新できます。セキュリティ保護とマスキング機能を内蔵しています。
## 依存関係
| 依存関係 | インストールコマンド |
| --- | --- |
| `python-dotenv` ≥ 1.0.0 | `pip install python-dotenv>=1.0.0` |
オプション依存関係のインストールに含まれています:`pip3 install -r requirements-optional.txt`
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `action` | string | はい | 操作タイプ:`get`、`set`、`list`、`delete` |
| `key` | string | いいえ | 環境変数名 |
| `value` | string | いいえ | 環境変数の値(`set` の場合のみ) |
## 使い方
設定したいキーをAgentに伝えると、自動的にこのToolが呼び出されます
- 「BOCHA_API_KEYを設定して」
- 「OPENAI_API_KEYをsk-xxxに設定して」
- 「設定済みの環境変数を表示して」
設定されたキーは `bash` Toolの実行環境に自動的に注入されます。
<Frame>
<img src="https://cdn.link-ai.tech/doc/20260202234939.png" width="800" />
</Frame>

50
docs/ja/tools/index.mdx Normal file
View File

@@ -0,0 +1,50 @@
---
title: Tools 概要
description: CowAgent 組み込みToolシステム
---
Toolは、AgentがOSリソースにアクセスするための中核機能です。Agentはタスクの要件に基づいてToolをインテリジェントに選択・呼び出し、ファイル操作、コマンド実行、Web検索、スケジュールタスクなどを実行します。Toolは `agent/tools/` ディレクトリに実装されています。
## 組み込みTool
以下のToolは追加設定なしでデフォルトで利用可能です
<CardGroup cols={2}>
<Card title="read - ファイル読み取り" icon="file" href="/ja/tools/read">
ファイル内容を読み取り、テキスト・画像・PDFに対応
</Card>
<Card title="write - ファイル書き込み" icon="pen" href="/ja/tools/write">
ファイルの作成または上書き
</Card>
<Card title="edit - ファイル編集" icon="pen-to-square" href="/ja/tools/edit">
テキスト置換によるファイル編集
</Card>
<Card title="ls - ディレクトリ一覧" icon="folder-open" href="/ja/tools/ls">
ディレクトリの内容を一覧表示
</Card>
<Card title="bash - ターミナル" icon="terminal" href="/ja/tools/bash">
システムコマンドの実行
</Card>
<Card title="send - ファイル送信" icon="paper-plane" href="/ja/tools/send">
ファイルや画像をユーザーに送信
</Card>
<Card title="memory - メモリ" icon="brain" href="/ja/tools/memory">
長期メモリの検索と読み取り
</Card>
</CardGroup>
## オプションTool
以下のToolは追加の依存関係またはAPIキーの設定が必要です
<CardGroup cols={2}>
<Card title="env_config - 環境設定" icon="key" href="/ja/tools/env-config">
APIキーとシークレットの管理
</Card>
<Card title="scheduler - スケジューラ" icon="clock" href="/ja/tools/scheduler">
スケジュールタスクの作成と管理
</Card>
<Card title="web_search - Web検索" icon="magnifying-glass" href="/ja/tools/web-search">
インターネットからリアルタイム情報を検索
</Card>
</CardGroup>

23
docs/ja/tools/ls.mdx Normal file
View File

@@ -0,0 +1,23 @@
---
title: ls - ディレクトリ一覧
description: ディレクトリの内容を一覧表示
---
ディレクトリの内容をアルファベット順にソートして一覧表示します。ディレクトリには `/` が付与され、隠しファイルも含まれます。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | ディレクトリパス。相対パスはワークスペースディレクトリを基準とします |
| `limit` | integer | いいえ | 返すエントリの最大数、デフォルト500 |
## ユースケース
- プロジェクト構造の閲覧
- 特定ファイルの検索
- ディレクトリの存在確認

36
docs/ja/tools/memory.mdx Normal file
View File

@@ -0,0 +1,36 @@
---
title: memory - メモリ
description: 長期メモリの検索と読み取り
---
メモリToolには `memory_search`(メモリ検索)と `memory_get`メモリファイル読み取りの2つのサブToolがあります。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。Agent Coreのメモリシステムによって管理されます。
## memory_search
キーワードとベクトルのハイブリッド検索で過去のメモリを検索します。
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `query` | string | はい | 検索クエリ |
## memory_get
特定のメモリファイルの内容を読み取ります。
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | メモリファイルの相対パス(例:`MEMORY.md`、`memory/2026-01-01.md` |
| `start_line` | integer | いいえ | 開始行番号 |
| `end_line` | integer | いいえ | 終了行番号 |
## 仕組み
Agentは以下のシナリオでメモリToolを自動的に呼び出します
- ユーザーが重要な情報を共有した場合 → メモリに保存
- 過去のコンテキストが必要な場合 → 関連するメモリを検索
- 会話が一定の長さに達した場合 → 要約を抽出して保存

24
docs/ja/tools/read.mdx Normal file
View File

@@ -0,0 +1,24 @@
---
title: read - ファイル読み取り
description: ファイル内容の読み取り
---
ファイルの内容を読み取ります。テキストファイル、PDFファイル、画像メタデータを返すなどに対応しています。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | ファイルパス。相対パスはワークスペースディレクトリを基準とします |
| `offset` | integer | いいえ | 開始行番号1始まり。負の値は末尾からの読み取り |
| `limit` | integer | いいえ | 読み取る行数 |
## ユースケース
- 設定ファイルやログファイルの閲覧
- コードファイルの読み取りと分析
- 画像・動画ファイルの情報確認

View File

@@ -0,0 +1,40 @@
---
title: scheduler - スケジューラ
description: スケジュールタスクの作成と管理
---
柔軟なスケジュール設定と実行モードを備えた、動的スケジュールタスクの作成と管理を行います。
## 依存関係
| 依存関係 | インストールコマンド |
| --- | --- |
| `croniter` ≥ 2.0.0 | `pip install croniter>=2.0.0` |
コア依存関係に含まれています:`pip3 install -r requirements.txt`
## スケジュールモード
| モード | 説明 |
| --- | --- |
| ワンタイム | 指定した時刻に1回だけ実行 |
| 固定間隔 | 一定の時間間隔で繰り返し実行 |
| Cron式 | Cron構文を使用した複雑なスケジュール定義 |
## 実行モード
- **固定メッセージ**: トリガー時にプリセットメッセージを送信
- **Agent動的タスク**: トリガー時にAgentがインテリジェントにタスクを実行
## 使い方
自然言語でスケジュールタスクを作成・管理できます:
- 「毎朝9時に天気予報を送って」
- 「2時間ごとにサーバーのステータスを確認して」
- 「明日の午後3時に会議のリマインドをして」
- 「すべてのスケジュールタスクを表示して」
<Frame>
<img src="https://cdn.link-ai.tech/doc/20260202195402.png" width="800" />
</Frame>

23
docs/ja/tools/send.mdx Normal file
View File

@@ -0,0 +1,23 @@
---
title: send - ファイル送信
description: ユーザーへのファイル送信
---
ユーザーにファイル(画像、動画、音声、ドキュメントなど)を送信します。ユーザーが明示的にファイルの送信・共有を要求した場合に使用されます。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | ファイルパス。絶対パスまたはワークスペースからの相対パス |
| `message` | string | いいえ | 添付メッセージ |
## ユースケース
- 生成したコードやドキュメントをユーザーに送信
- スクリーンショットやチャートの送信
- ダウンロードしたファイルの共有

View File

@@ -0,0 +1,32 @@
---
title: web_search - Web検索
description: インターネットからリアルタイム情報を検索
---
インターネットからリアルタイムの情報、ニュース、リサーチなどを検索します。2つの検索バックエンドに対応し、自動フォールバック機能を備えています。
## 依存関係
少なくとも1つの検索APIキーが必要です`env_config` Toolまたはワークスペースの `.env` ファイルで設定):
| バックエンド | 環境変数 | 優先度 | 取得方法 |
| --- | --- | --- | --- |
| Bocha Search | `BOCHA_API_KEY` | プライマリ | [Bocha Open Platform](https://open.bochaai.com/) |
| LinkAI Search | `LINKAI_API_KEY` | フォールバック | [LinkAI Console](https://link-ai.tech/console/interface) |
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `query` | string | はい | 検索キーワード |
| `count` | integer | いいえ | 結果件数1-50、デフォルト10 |
| `freshness` | string | いいえ | 期間指定:`noLimit`、`oneDay`、`oneWeek`、`oneMonth`、`oneYear`、または `2025-01-01..2025-02-01` のような日付範囲 |
| `summary` | boolean | いいえ | ページ要約を返すデフォルトfalse |
## ユースケース
ユーザーが最新情報について質問したり、事実確認やリアルタイムデータが必要な場合、AgentはこのToolを自動的に呼び出します。
<Note>
検索APIキーが設定されていない場合、このToolは読み込まれません。
</Note>

27
docs/ja/tools/write.mdx Normal file
View File

@@ -0,0 +1,27 @@
---
title: write - ファイル書き込み
description: ファイルの作成または上書き
---
ファイルにコンテンツを書き込みます。ファイルが存在しない場合は新規作成し、存在する場合は上書きします。親ディレクトリは自動的に作成されます。
## 依存関係
追加の依存関係は不要で、デフォルトで利用可能です。
## パラメータ
| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `path` | string | はい | ファイルパス |
| `content` | string | はい | 書き込む内容 |
## ユースケース
- 新しいコードファイルやスクリプトの作成
- 設定ファイルの生成
- 処理結果の保存
<Note>
1回の書き込みは10KBを超えないようにしてください。大きなファイルの場合は、まずスケルトンを作成し、editツールを使用してチャンクごとにコンテンツを追加してください。
</Note>