Skip to main content

插件代理工具

OpenClaw 插件可以注册代理工具(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",  // specific tool name
            "workflow",       // plugin id (enables all tools from that plugin)
            "group:plugins"   // all plugin tools
          ]
        }
      }
    ]
  }
}
影响工具可用性的其他配置选项:
  • 仅列出插件工具的允许列表被视为插件的启用请求;除非您同时将核心工具或工具组列入允许列表,否则核心工具将保持启用状态。
  • tools.profile / agents.list[].tools.profile(基础允许列表)
  • tools.byProvider / agents.list[].tools.byProvider(特定提供商的允许/拒绝列表)
  • tools.sandbox.tools.*(沙箱模式下的沙箱工具策略)

规则与提示

  • 工具名称不得与核心工具名称冲突;冲突的工具将被跳过。
  • 允许列表中使用的插件 ID 不得与核心工具名称冲突。
  • 对于会触发副作用或需要额外二进制文件/凭据的工具,建议使用optional: true