Tools

Inspect a tool with sim tools get <toolId> before passing its parameters to sim tools execute.

These commands accept the global options.

List tools

Code

sim tools list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the tool id, name, and description.
`--hosted-api-key <value>`	No	Restrict to tools by how their API key is supplied. Accepted values: `always`, `conditional`, `none`.
`--oauth-provider <value>`	No	Restrict to tools that authenticate against this OAuth service.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "id". Accepted values: `id`, `name`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listTools.

Code

sim tools get <toolId>

Arguments

Argument	Required	Description
`toolId`	Yes	Tool identifier. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The response echoes the resolved ID.

API request and response schemas: getTool.

OAuth login or personal API key required.

Code

sim tools execute <toolId> [options]

Arguments

Argument	Required	Description
`toolId`	Yes	Tool identifier. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The response echoes the resolved ID.

Options

Option	Required	Description
`--input <json\|@file>`	No	Tool arguments as JSON, keyed by the parameter ids `sim tools get <toolId>` lists. Defaults to {}. (JSON, or @path / @- to read a file or stdin).
`--credential-id <value>`	No	Credential to authenticate with, required for OAuth tools.
`--timeout <value>`	No	Seconds to wait before abandoning the call.

API request and response schemas: executeTool.