Skip to content

Latest commit

 

History

History
152 lines (118 loc) · 2.42 KB

File metadata and controls

152 lines (118 loc) · 2.42 KB

Native tools

  • execute_bash — Execute a shell command.
  • fs_read — Read files, directories, and images.
  • fs_write — Create and edit files.
  • gh_issue — Open a GitHub issue template.
  • knowledge — Store and retrieve information in a knowledge base.
  • thinking — Internal reasoning mechanism.
  • use_aws — Make AWS CLI API calls.

The execute_bash tool

Execute the specified bash command.

Schema

{
  "type": "object",
  "properties": {
    "allowedCommands": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    },
    "allowReadOnly": {
      "type": "boolean",
      "default": true
    }
  }
}

Example

{
  "allowedCommands": ["git status", "git fetch"],
  "allowReadOnly": true
}

The fs_read tool

Tool for reading files, directories and images.

Schema

{
  "type": "object",
  "properties": {
    "allowedPaths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    }
  }
}

Example

{
  "allowedPaths": ["~"]
}

The fs_write tool

Tool for creating and editing files.

Schema

{
  "type": "object",
  "properties": {
    "allowedPaths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    }
  }
}

Example

{
  "allowedPaths": [
    "~/file-to-create.txt",
    "~/editable-file.txt",
    "~/my-workspace/"
  ]
}

The gh_issue tool

Opens the browser to our GitHub template for reporting issues with q.

This tool has no configuration.

The knowledge tool

Store and retrieve information in knowledge base across chat sessions

This tool has no configuration.

The thinking tool

Thinking is an internal reasoning mechanism improving the quality of complex tasks by breaking their atomic actions down.

This tool has no configuration.

The use_aws tool

Make an AWS CLI api call with the specified service, operation, and parameters.

Schema

{
  "type": "object",
  "properties": {
    "allowedServices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    }
  }
}

Example

{
  "allowedServices": ["s3", "iam"]
}