AgentBay:CodeSpace

Tool

Name

Description

Support notes

CodeSpace

run_code

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

Supported

Shell

shell

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

Supported

File system

create_directory

Creates a new directory or ensures that a directory exists. You can create multiple nested directories in one operation. If the directory already exists, this operation succeeds without returning a message. This tool is ideal for setting up the directory structure for a project or ensuring that a required path exists. It only works in allowed directories.

Supported

edit_file

Performs line-based edits on a text file. Each edit replaces an exact sequence of lines with new content. It returns a git-style diff to show the changes made. It only works in allowed directories.

Supported

get_file_info

Retrieves detailed metadata for a file or directory. It returns comprehensive information, including size, creation time, last modification time, permissions, and type. This tool is ideal for understanding file attributes without reading the actual content. It only works 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. It handles various text encodings and provides detailed error messages if the file cannot be read. It only works in allowed directories.

Supported

read_multiple_files

Reads the content of multiple files at the same time. This is more efficient than reading files one by one when you need to analyze or compare multiple files. 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. It only works in allowed directories.

Supported

list_directory

Gets a detailed list of all files and directories in a specified path. The results clearly distinguish between files and directories with the [FILE] and [DIR] prefixes. This tool is useful for understanding the directory structure and finding specific files. It only works 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. It can work between different directories and can be used for simple renaming within the same directory. Both the source and destination must be in allowed directories.

Supported

search_files

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

Supported

write_file

Creates a new file or writes content to an existing file. You can choose to completely overwrite the file or append to the end of the file 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. It handles text content with the appropriate encoding. It only works in allowed directories.

Supported

OSS

oss_env_init

Creates and initializes OSS environment variables. Specify the endpoint, access key ID, access key secret, security token, and region. Temporary security credentials are obtained through Security Token Service (STS). For more information, see Use temporary access credentials provided by STS to access OSS.

Supported

oss_upload

Uploads a local file or directory to a specified OSS bucket. If you upload a directory, it is first compressed into a zip file. You can specify the object name in OSS. If you do not specify a name, the file or zip name is used by default. Note: Before using this tool, call the oss_env_init tool to initialize the OSS environment variables.

Supported

oss_download

Downloads an object from a specified OSS bucket to a local path. If the parent directory does not exist, it is automatically created. If the object file already exists, it is overwritten. Note: Before using this tool, call the oss_env_init tool to initialize the OSS environment variables.

Supported

oss_upload_annon

Uploads a local file or directory to a specified URL using HTTP PUT. If you upload a directory, it is first compressed into a zip file. If the destination already exists, it is overwritten.

Supported

oss_download_annon

Downloads a file from a specified URL to a local path. If the parent directory does not exist, it is automatically created. If the object file already exists, it is overwritten.

Supported

Name

Description

Parameters

run_code

Runs code in a specified context on the 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": "The timeout for command execution in seconds. If not specified, a default value, such as 300 seconds, is used. 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": "The timeout for command execution in milliseconds. If not specified, a default value, such as 1000 milliseconds, is used.",
        "type": "integer"
      }
    },
    "required": ["command", "timeout_ms"],
    "type": "object"
  }
}

Name

Description

Parameters

create_directory

Creates a new directory or ensures that a directory exists. You can create multiple nested directories in one operation. If the directory already exists, this operation succeeds without returning a message. This tool is ideal for setting up the directory structure for a project or ensuring that a required path exists. It only works in allowed directories.

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

edit_file

Performs line-based edits on a text file. Each edit replaces an exact sequence of lines with new content. It returns a git-style diff to show the changes made. It only works in allowed directories.

{
  "inputSchema": {
    "properties": {
      "dryRun": {
        "default": false,
        "description": "Preview 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. It returns comprehensive information, including size, creation time, last modification time, permissions, and type. This tool is ideal for understanding file attributes without reading the actual content. It only works in allowed directories.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The path of the file or directory to check.",
        "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. It handles various text encodings and provides detailed error messages if the file cannot be read. It only works in allowed directories.

{
  "inputSchema": {
    "properties": {
      "length": {
        "description": "The number of bytes to read. If this parameter is 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 the same time. This is more efficient than reading files one by one when you need to analyze or compare multiple files. 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. It only works 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. The results clearly distinguish between files and directories with the [FILE] and [DIR] prefixes. This tool is useful for understanding the directory structure and finding specific files. It only works 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. It can work between different directories and can be used for simple renaming within the same directory. Both 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. It searches all subdirectories from a starting path. The search is case-sensitive and matches partial names. It returns the full path for all matching items. This is ideal for finding files when you do not know their exact location. It only searches in 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 choose to completely overwrite the file or append to the end of the file 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. It handles text content with the appropriate encoding. It only works 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"
  }
}

Name

Description

Parameters

oss_env_init

Creates and initializes OSS environment variables. Specify the endpoint, access key ID, access key secret, security token, and region. Temporary security credentials are obtained through Security Token Service (STS). For more information, see Use temporary access credentials provided by STS to access OSS.

{
  "inputSchema": {
    "properties": {
      "access_key_id": {
        "description": "The AccessKey ID for OSS identity verification.",
        "type": "string"
      },
      "access_key_secret": {
        "description": "The AccessKey secret for OSS identity verification.",
        "type": "string"
      },
      "endpoint": {
        "description": "The OSS service endpoint. If this parameter is not specified, the default value https://oss-cn-hangzhou.aliyuncs.com is used.",
        "type": "string"
      },
      "region": {
        "description": "The OSS region. Example: cn-hangzhou. If this parameter is not specified, the default value cn-hangzhou is used.",
        "type": "string"
      },
      "security_token": {
        "description": "The security token for OSS identity verification.",
        "type": "string"
      }
    },
    "required": ["access_key_id", "access_key_secret", "security_token"],
    "type": "object"
  }
}

oss_upload

Uploads a local file or directory to a specified OSS bucket. If you upload a directory, it is first compressed into a zip file. You can specify the object name in OSS. If you do not specify a name, the file or zip name is used by default. Note: Before using this tool, call the oss_env_init tool to initialize the OSS environment variables.

{
  "inputSchema": {
    "properties": {
      "bucket": {
        "description": "The name of the OSS bucket.",
        "type": "string"
      },
      "object": {
        "description": "The object path in the OSS bucket. Example: test/test.txt.",
        "type": "string"
      },
      "path": {
        "description": "The full path of the local file or non-empty directory to upload. Examples: /tmp/test.txt or /tmp on Linux, or C:/tmp/test.txt or C:/tmp on Windows.",
        "type": "string"
      }
    },
    "required": ["bucket", "object", "path"],
    "type": "object"
  }
}

oss_download

Downloads an object from a specified OSS bucket to a local path. If the parent directory does not exist, it is automatically created. If the object file already exists, it is overwritten. Note: Before using this tool, call the oss_env_init tool to initialize the OSS environment variables.

{
  "inputSchema": {
    "properties": {
      "bucket": {
        "description": "The name of the OSS bucket.",
        "type": "string"
      },
      "object": {
        "description": "The object path in the OSS bucket. Example: test/test.txt.",
        "type": "string"
      },
      "path": {
        "description": "The full local path where the downloaded file is saved. Example: /tmp/test.txt on Linux or C:/tmp/test.txt on Windows.",
        "type": "string"
      }
    },
    "required": ["bucket", "object", "path"],
    "type": "object"
  }
}

oss_upload_annon

Uploads a local file or directory to a specified URL using HTTP PUT. If you upload a directory, it is first compressed into a zip file. If the destination already exists, it is overwritten.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The full path of the local file or non-empty directory to upload. Examples: /tmp/test.txt or /tmp on Linux, or C:/tmp/test.txt or C:/tmp on Windows.",
        "type": "string"
      },
      "url": {
        "description": "The HTTP or HTTPS URL to which to upload the file.",
        "type": "string"
      }
    },
    "required": ["url", "path"],
    "type": "object"
  }
}

oss_download_annon

Downloads a file from a specified URL to a local path. If the parent directory does not exist, it is automatically created. If the object file already exists, it is overwritten.

{
  "inputSchema": {
    "properties": {
      "path": {
        "description": "The full local path where the downloaded file is saved. Example: /tmp/test.txt on Linux or C:/tmp/test.txt on Windows.",
        "type": "string"
      },
      "url": {
        "description": "The HTTP or HTTPS URL from which to download the file.",
        "type": "string"
      }
    },
    "required": ["url", "path"],
    "type": "object"
  }
}