Skip to main content

Tool

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Defines a tool (HTTP endpoint, MCP server, or SOAT action) that agents can invoke during a generation.

Syntax​

type: tool
properties:
  name: String
  type: String
  description: String
  parameters: Object
  execute: Execute
  mcp: Mcp
  actions: String[]
  preset_parameters: Object

Types: Execute · Mcp

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyTool

Properties​

name

Tool display name

Required: Yes Type: String

type

Tool type hint (e.g. http, mcp, soat)

Required: No Type: String Nullable: Yes

description

Tool description shown to the model

Required: No Type: String Nullable: Yes

parameters

JSON Schema describing the tool's input parameters (free-form, user-defined)

Required: No Type: Object Nullable: Yes

execute

HTTP execution configuration. Required for http tools.

Required: No Type: Execute Nullable: Yes

mcp

MCP server connection configuration. Required for mcp tools.

Required: No Type: Mcp Nullable: Yes

actions

IAM action strings the tool is permitted to call

Required: No Type: Array of String Nullable: Yes

preset_parameters

Pre-filled parameter values injected at execution time

Required: No Type: Object Nullable: Yes

Sub-types​

Execute​

Properties of the execute object.

url

Endpoint URL. Supports {param} placeholders resolved from tool arguments.

Required: No Type: String

method

HTTP method (default: POST)

Required: No Type: String Nullable: Yes

headers

Static headers included in every request

Required: No Type: Object Nullable: Yes

Mcp​

Properties of the mcp object.

url

MCP server URL

Required: No Type: String

headers

Headers included in every MCP request

Required: No Type: Object Nullable: Yes