file-browser-tool for Openclaw

Requirements

• Supported AI agent platforms: Claude Code, Cursor, Codex, Gemini CLI, and similar SKILL.md-compatible agents.
• Supported operating systems: Windows, macOS, Linux.
• Required capability: LLM API access provided by the agent runtime.

Configuration

Set your API key as an environment variable:

export API_KEY="${API_KEY:?please set environment variable}"

After configuring credentials, restart the session or open a new terminal so the environment changes take effect. Keep API keys out of version control and store them securely.

Usage notes

• Use relative paths from the workspace root only.
• Ensure files are UTF-8 encoded for reliable reading.
• Keep file reads within the documented size and depth limits.
• Use the agent’s tool invocation flow to call file-browser-tool in Openclaw Skills.

file-browser-tool organizes its data around a simple request/response contract optimized for read-only workspace access in Openclaw Skills.

Input fields

Output structure

{
  "success": true,
  "data": {
    "final_result": {
      "tool_result": "tool_result_value",
      "tool_metadata": "tool_metadata_value",
      "tool_status": "tool_status_value"
    },
    "execution_log": [
      {
        "step": 1,
        "name": "step name",
        "status": "completed",
        "duration_ms": 1200,
        "output_summary": "summary"
      }
    ],
    "total_duration_ms": 7600,
    "gates_passed": 3,
    "gates_total": 3
  },
  "error": null
}

Metadata taxonomy

• success: Boolean success flag.
• data.final_result: Main tool payload, metadata, and status.
• data.execution_log: Step-by-step execution trace.
• data.total_duration_ms: Total runtime in milliseconds.
• data.gates_passed / data.gates_total: Workflow gate progress.
• error: Error message when execution fails.

Behavioral constraints

• Read-only operations only; no file mutation.
• Paths are resolved relative to the workspace.
• Single-file concurrency is constrained to preserve access safety.
• Large or binary files may return error responses instead of content.