プラグインエージェントツール

OpenClaw プラグインは、エージェント実行中に LLM に公開されるエージェントツール(JSON スキーマ関数)を登録できます。ツールは必須(常に利用可能)またはオプション(オプトイン)のいずれかです。

エージェントツールはメイン設定の tools か、エージェントごとの agents.list[].tools で設定します。許可リスト/拒否リストのポリシーで、エージェントが呼び出せるツールを制御します。

基本的なツール

import { Type } from "@sinclair/typebox";

export default function (api) {
  api.registerTool({
    name: "my_tool",
    description: "Do a thing",
    parameters: Type.Object({
      input: Type.String(),
    }),
    async execute(_id, params) {
      return { content: [{ type: "text", text: params.input }] };
    },
  });
}

オプションツール(オプトイン)

オプションツールは自動有効化されません。ユーザーがエージェントの許可リストに追加する必要があります。

export default function (api) {
  api.registerTool(
    {
      name: "workflow_tool",
      description: "Run a local workflow",
      parameters: {
        type: "object",
        properties: {
          pipeline: { type: "string" },
        },
        required: ["pipeline"],
      },
      async execute(_id, params) {
        return { content: [{ type: "text", text: params.pipeline }] };
      },
    },
    { optional: true },
  );
}

オプションツールは agents.list[].tools.allow(またはグローバルの tools.allow)で有効にします。

{
  agents: {
    list: [
      {
        id: "main",
        tools: {
          allow: [
            "workflow_tool", // 特定のツール名
            "workflow", // プラグイン ID(そのプラグインの全ツールを有効化)
            "group:plugins", // すべてのプラグインツール
          ],
        },
      },
    ],
  },
}

ツールの利用可否に影響する他の設定:

  • プラグインツールのみを指定した許可リストはプラグインのオプトインとして扱われます。許可リストにコアツールやグループも含めない限り、コアツールは有効なままです。
  • tools.profile / agents.list[].tools.profile(ベース許可リスト)
  • tools.byProvider / agents.list[].tools.byProvider(プロバイダごとの許可/拒否)
  • tools.sandbox.tools.*(サンドボックス時のツールポリシー)

ルールとヒント

  • ツール名はコアツール名と重複してはなりません。重複するツールはスキップされます。
  • 許可リストで使用するプラグイン ID もコアツール名と重複してはなりません。
  • 副作用を伴うツールや追加のバイナリ/認証情報が必要なツールには optional: true を推奨します。