Get a plugin's tools

GET https://runix.chat/api/v1/armada/plugins/{install_id}/tools

The tools a running plugin offers the agent, as the plugin lists them now, with whether the organization turned each off (the plugin's disabled_tools, which updating the plugin sets).

A tool's title and description are the plugin's own words, to be shown as plain text.

Guests and bots cannot use this endpoint.

Changes: New in Zulip 13.0 (feature level ZF-0be29a).

Usage examples

curl -sSX GET -G https://runix.chat/api/v1/armada/plugins/1/tools \
    -u EMAIL_ADDRESS:API_KEY

Parameters

Response

Return values

• tools: (object)[]

  The plugin's tools, in its order.

  • name: string

    The tool's name, as the agent calls it.

  • title: string | null

    The tool's title, if the plugin gives one.

  • description: string

    What the tool does, in the plugin's words; may be empty.

  • disabled: boolean

    Whether the organization turned the tool off.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "tools": [
        {
            "description": "The project's runs and their state.",
            "disabled": false,
            "name": "list_runs",
            "title": "List runs"
        },
        {
            "description": "",
            "disabled": true,
            "name": "compare_runs",
            "title": null
        }
    ]
}