Placeholder Tool #

The placeholder tool performs no action. This tool is intended to be used during testing or when there is no need for other tools in the parent entity (e.g., a strategy whose tool list must have at least one element).

The placeholder tool can be backtested. More information about strategy backtesting can be found here.

Configuration #

{
	"type": "placeholder",
	"description": "a simple tool",
	"permit": true
}

• type - string
  The type of the tool configuration.

  Tool configuration types are described in detail here.

• description - string (optional; default: unused)
  The description of the tool and its purpose.

• permit - boolean (optional; default: false)
  The property that is used as the tool’s execution result.

  The tool execution flow is described in detail here.

Report #

{
	"type": "placeholder",
	"permit": true
}

• type - string
  The type of the tool report.

  Tool report types are described in detail here.

• permit - boolean
  The property that determines whether the tool gave its permission to continue strategy execution or not.

  The tool execution flow is described in detail here.

Context #

The placeholder tool does not insert any objects into the context store.