OpenClaw、Hermes、QoderWork、CherryStudio、Claude Code などのエージェントは、tablestore-agent-cli コマンドラインツールとエージェントスキル (tablestore-agent-knowledge) を介して同じナレッジストアにアクセスできます。そのため、どのエージェントフレームワークを使用しても知識は永続化されます。
前提条件
CLI とスキルの概要
tablestore-agent-cli は、ナレッジストアを管理するためのコマンドラインツールです。すべてのコマンドは、デフォルトで構造化 JSON を返すため、エージェントが直接解析できます。tablestore-agent-knowledge は、自然言語による指示からエージェントがナレッジストアの操作を実行できるようにする、対応するエージェントスキルパッケージです。
|
グローバルパラメーター |
説明 |
|
|
レスポンスエンベロープ ( |
|
|
確認プロンプトをスキップします。スクリプトや CI パイプラインで役立ちます。 |
|
|
インスタンス名を指定します。省略した場合、デフォルトで |
|
|
コマンドタイムアウトを設定します。デフォルトは 30 秒です。 |
インストールと設定
CLI のインストール
CLI を使用するには Node.js 18 以降が必要です。次のコマンドを実行してインストールします:
npm install -g @tablestore/tablestore-agent-cli --registry=https://registry.npmjs.org/
インストールを確認します:
tablestore-agent-cli --version
認証情報の設定
リージョン、AccessKey、および Tablestore インスタンス設定のみを手動で設定します。OSS の操作を初めて実行する際に、OSS エンドポイントとバケットはリージョンから自動的に導出されます。
tablestore-agent-cli configure set region cn-hangzhou
tablestore-agent-cli configure set access_key_id <AccessKey ID>
tablestore-agent-cli configure set access_key_secret <AccessKey Secret>
tablestore-agent-cli configure set ots_endpoint https://<instance-name>.cn-hangzhou.ots.aliyuncs.com
tablestore-agent-cli configure set ots_instance_name <instance-name>
設定後、接続性チェックを実行します:
tablestore-agent-cli doctor
すべての項目が status=pass と表示されていれば、設定は完了です。
エージェントフレームワークの接続
スキルまたはコマンドラインからの呼び出し (OpenClaw、Hermes、QoderWork、CherryStudio、Claude Code など) をサポートするエージェントであれば、同一のスキルパッケージと認証情報を使用してナレッジストアにアクセスできます。統合は次の 3 ステップで行います:
スキルをインストールします (エージェントにスキルパッケージの URL を指定します)。
認証情報を設定します (手動で
configure setを実行するか、トークンでインポートします)。自然言語でナレッジストアを操作します。
スキルのインストール
エージェントとの会話で次の指示を入力します。エージェントがスキルを学習し、CLI を自動的にインストールします。
Please learn the skill at https://tablestore-doc.oss-cn-hangzhou.aliyuncs.com/aliyun-tablestore-ai/agent-storage/tablestore-agent-knowledge.zip and install the CLI.
設定
機密性の高い認証情報をエージェントとの会話で露出しないために、configure set コマンドで AccessKey を直接設定してください。エージェントはリージョンとインスタンス設定を支援できます。
リージョン、AccessKey ID、AccessKey Secret を設定すると、初回利用時に CLI が OSS バケットを自動的に設定し、Tablestore インスタンスに接続します。
使用例
設定後、会話内で自然言語を使用してナレッジストアを操作します。
Create a knowledge store called project_wiki and upload the documents in ./docs.
Search project_wiki for content about the deployment process.
エージェントは自然言語による指示を CLI コマンドに変換し、ナレッジストア管理、ドキュメント管理、チャンク管理、取得操作に対応しています。
デバイス間でのナレッジストア共有
ソースデバイスを設定した後、トークンをエクスポートし、ターゲットデバイスでインポートすることで、複数のエンドポイントから同じナレッジストアにアクセスできます。
トークンのエクスポート
ソースデバイスで tablestore-agent-cli configure export を実行します:
tablestore-agent-cli configure export
出力は次の形式です:
instance=<instance-name> token=tablestore_agent_storage://eyJ2IjoyLC...
トークンのインポート
ターゲットデバイスで次のコマンドを実行します:
tablestore-agent-cli configure import --name <instance-name> <token>
トークンをインポートした後、--instance グローバルパラメーターを使用して、そのインスタンス上のナレッジストアにアクセスします。
tablestore-agent-cli --instance <instance-name> -q kb retrieve --kb product_docs --query "deployment process"
または、トークンをターゲットエージェントに直接送信し、インポートを実行させることもできます。
My token is tablestore_agent_storage://eyJ2IjoyLC.... Please import the knowledge store configuration.
ダッシュボード
CLI には組み込みのビジュアルダッシュボードが含まれています。次のコマンドで起動します:
tablestore-agent-cli dashboard start
ダッシュボードを使用して、ナレッジストアとメモリストアの管理およびデバッグを行えます。主な機能は次のとおりです:
取得パラメーターとインデックス設定 (searchType、top-k、リランク戦略) の調整
エンドツーエンドの取得結果の検証
複数のナレッジストアのマウントと比較テストのための切り替え
LLM とのチャット、および取得結果を注入した後の Q&A パフォーマンスの確認
注意事項
エージェントとの会話内で認証情報をプレーンテキストのまま渡さないでください。
configure setコマンドを直接使用して AccessKey を設定してください。configure exportコマンドは、AccessKey を含むすべての認証情報をエンコードしたトークンを出力します。トークンは安全なチャネル (パスワードマネージャーなど) で転送し、公開しないでください。インスタンス名で使用できる文字は、英字、数字、ハイフンのみです。
ドキュメントをアップロードすると、システムはコンテンツを解析してベクトル化し、非同期に処理します。
kb doc-listを使用してドキュメントのステータスを確認し、statusがcompletedになるまで待ってから取得を実行してください。