AgentBay:CodeSpace

Tool

Name

Description

Support status

System

create_sandbox

Creates a new AgentBay sandbox environment and returns its ID.

Supported

kill_sandbox

Releases resources after a task is complete.

Supported

shell

Executes a shell command on a Linux platform. It supports timeout control and returns the command output or an error message.

Supported

CodeSpace

run_code

Runs code in a specified context on a Linux platform and returns the output or an error.

Supported

Shell

shell

Executes a shell command and returns the output or an error.

Supported

FileSystem

create_directory

Creates a new directory or ensures that one exists. You can create multiple nested directories in a single operation. If the directory already exists, the operation succeeds silently. This is ideal for setting up a project's directory structure or ensuring that required paths exist. This tool works only in allowed directories.

Supported

edit_file

Edits a text file line by line. Each edit replaces an exact line sequence with new content. Returns a git-style diff to show the changes. This tool works only in allowed directories.

Supported

get_file_info

Retrieves detailed metadata for a file or directory. Returns comprehensive information such as size, creation time, last modified time, permissions, and type. This tool is useful for understanding file attributes without reading the content. This tool works only in allowed directories.

Supported

read_file

Reads the content of a file from the file system. You can specify an optional offset in bytes to start reading from a specific position, and an optional length in bytes to limit the number of bytes to read. If length is omitted or is 0, the file is read to the end. The tool handles various text encodings and provides detailed error messages if the file cannot be read. This tool works only in allowed directories.

Supported

read_multiple_files

Reads the content of multiple files at once. This is more efficient than reading files one by one when you need to analyze or compare them. The content of each file is returned with its path as a reference. A failure to read a single file does not stop the entire operation. This tool works only in allowed directories.

Supported

list_directory

Gets a detailed list of all files and directories in a specified path. Results use [FILE] and [DIR] prefixes to distinguish between files and directories. This tool is useful for understanding a directory structure and finding specific files. This tool works only in allowed directories.

Supported

move_file

Moves or renames files and directories. You can move a file to a different directory and rename it in a single operation. If the destination already exists, the operation fails. The tool works across different directories and can be used for simple renames within the same directory. The source and destination must be in allowed directories.

Supported

search_files

Recursively searches for files and directories that match a pattern. The search includes all subdirectories from the starting path. The search is case-sensitive and matches partial names. It returns the full path for all matching items. This is useful for finding files when you do not know their exact location. The search is limited to allowed directories.

Supported

write_file

Creates a new file or writes content to an existing file. You can overwrite the file or append content to it by specifying the mode parameter. Use the overwrite mode (default) to clear the file before writing, or use the append mode to add content to the end of the file. The tool handles text content with the correct encoding. This tool works only in allowed directories.

Supported

Name

Description

Parameters

create_sandbox

Creates a new AgentBay sandbox environment and returns its ID.

{
  "type": "object",
  "properties": {},
  "required": []
}

kill_sandbox

Releases resources after a task is complete.

{
  "type": "object",
  "properties": {
    "sandbox_id": {
      "type": "string",
      "title": "Sandbox Id",
      "description": "The sandbox ID is the identifier for the tool execution environment. This sandbox_id comes from the create_sandbox tool."
    }
  },
  "required": [
    "sandbox_id"
  ]
}

shell

Executes a shell command on a Linux platform. It supports timeout control and returns the command output or an error message.

{
  "type": "object",
  "required": [
    "sandbox_id",
    "command",
    "timeout_ms"
  ],
  "properties": {
    "sandbox_id": {
      "type": "string",
      "title": "Sandbox Id",
      "description": "The sandbox ID is the identifier for the tool execution environment. This sandbox_id comes from the create_sandbox tool."
    },
    "cwd": {
      "description": "The working directory for command execution",
      "type": "string"
    },
    "envs": {
      "description": "Environment variables for command execution, e.g. {\"env1\":\"123\",\"env2\":\"abc\"}",
      "type": "object"
    },
    "timeout_ms": {
      "default": 1000,
      "description": "Command execution timeout in milliseconds. If not specified, the default value of 1000 ms is used.",
      "type": "integer"
    },
    "command": {
      "description": "The command entered by the client.",
      "type": "string"
    }
  }
}

Name

Description

Parameters

run_code

Runs code in a specified context on a Linux platform and returns the output or an error.

{
  "inputSchema": {
    "properties": {
      "code": {
        "description": "The code to execute.",
        "type": "string"
      },
      "language": {
        "description": "The programming language for code execution. Supported values: 'python', 'javascript'. If not specified, Python is used by default.",
        "type": "string"
      },
      "timeout_s": {
        "default": 300,
        "description": "Command execution timeout in seconds. If not specified, the default value is 300 seconds. The maximum value is 3600 seconds.",
        "type": "integer"
      }
    },
    "required": ["code"],
    "type": "object"
  }
}

Name

Description

Parameters

shell

Executes a shell command and returns the output or an error.

{
  "inputSchema": {
    "properties": {
      "command": {
        "description": "The command entered by the client.",
        "type": "string"
      },
      "timeout_ms": {
        "default": 1000,
        "description": "Command execution timeout in milliseconds. If not specified, the default value of 1000 ms is used.",
        "type": "integer"
      }
    },
    "required": ["command", "timeout_ms"],
    "type": "object"
  }
}

Name

Description

Parameters

create_directory

Creates a new directory or ensures that one exists. You can create multiple nested directories in a single operation. If the directory already exists, the operation succeeds silently. This is ideal for setting up a project's directory structure or ensuring that required paths exist. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The path of the directory to create.",
        "type": "string"
      }
    },
    "required": ["path"],
    "type": "object"
  }
}

edit_file

Edits a text file line by line. Each edit replaces an exact line sequence with new content. Returns a git-style diff to show the changes. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "dryRun": {
        "default": false,
        "description": "Previews changes in a git-style diff format.",
        "type": "boolean"
      },
      "edits": {
        "items": {
          "properties": {
            "newText": {
              "description": "The new text to use for replacement.",
              "type": "string"
            },
            "oldText": {
              "description": "The text to search for. An exact match is required.",
              "type": "string"
            }
          },
          "required": ["oldText", "newText"],
          "type": "object"
        },
        "type": "array"
      },
      "path": {
        "description": "The path of the file to edit.",
        "type": "string"
      }
    },
    "required": ["path", "edits"],
    "type": "object"
  }
}

get_file_info

Retrieves detailed metadata for a file or directory. Returns comprehensive information such as size, creation time, last modified time, permissions, and type. This tool is useful for understanding file attributes without reading the content. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The path of the file or directory to inspect.",
        "type": "string"
      }
    },
    "required": ["path"],
    "type": "object"
  }
}

read_file

Reads the content of a file from the file system. You can specify an optional offset in bytes to start reading from a specific position, and an optional length in bytes to limit the number of bytes to read. If length is omitted or is 0, the file is read to the end. The tool handles various text encodings and provides detailed error messages if the file cannot be read. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "length": {
        "description": "The number of bytes to read. If omitted or set to 0, the file is read to the end.",
        "minimum": 0,
        "type": "integer"
      },
      "offset": {
        "default": 0,
        "description": "The byte offset from which to start reading.",
        "minimum": 0,
        "type": "integer"
      },
      "path": {
        "description": "The path of the file to read.",
        "type": "string"
      }
    },
    "required": ["path"],
    "type": "object"
  }
}

read_multiple_files

Reads the content of multiple files at once. This is more efficient than reading files one by one when you need to analyze or compare them. The content of each file is returned with its path as a reference. A failure to read a single file does not stop the entire operation. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "paths": {
        "description": "An array of file paths to read.",
        "items": {
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": ["paths"],
    "type": "object"
  }
}

list_directory

Gets a detailed list of all files and directories in a specified path. Results use [FILE] and [DIR] prefixes to distinguish between files and directories. This tool is useful for understanding a directory structure and finding specific files. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The path of the directory to list.",
        "type": "string"
      }
    },
    "required": ["path"],
    "type": "object"
  }
}

move_file

Moves or renames files and directories. You can move a file to a different directory and rename it in a single operation. If the destination already exists, the operation fails. The tool works across different directories and can be used for simple renames within the same directory. The source and destination must be in allowed directories.

{
  "inputSchema": {
    "properties": {
      "destination": {
        "description": "The destination path for the file or directory.",
        "type": "string"
      },
      "source": {
        "description": "The source path of the file or directory.",
        "type": "string"
      }
    },
    "required": ["source", "destination"],
    "type": "object"
  }
}

search_files

Recursively searches for files and directories that match a pattern. The search includes all subdirectories from the starting path. The search is case-sensitive and matches partial names. It returns the full path for all matching items. This is useful for finding files when you do not know their exact location. The search is limited to allowed directories.

{
  "inputSchema": {
    "properties": {
      "excludePatterns": {
        "default": [],
        "description": "The patterns to exclude. This parameter is optional.",
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "path": {
        "description": "The directory path from which to start the search.",
        "type": "string"
      },
      "pattern": {
        "description": "The pattern to match.",
        "type": "string"
      }
    },
    "required": ["path", "pattern"],
    "type": "object"
  }
}

write_file

Creates a new file or writes content to an existing file. You can overwrite the file or append content to it by specifying the mode parameter. Use the overwrite mode (default) to clear the file before writing, or use the append mode to add content to the end of the file. The tool handles text content with the correct encoding. This tool works only in allowed directories.

{
  "inputSchema": {
    "properties": {
      "content": {
        "description": "The content to write.",
        "type": "string"
      },
      "mode": {
        "default": "overwrite",
        "description": "The write mode. 'overwrite' clears the file. 'append' adds content to the end of the file.",
        "enum": ["overwrite", "append"],
        "type": "string"
      },
      "path": {
        "description": "The path of the file to write to.",
        "type": "string"
      }
    },
    "required": ["path", "content"],
    "type": "object"
  }
}