Working with tools

1
import { FlowBuilder, RuntypeClient } from '@runtypelabs/sdk'
2
3
const client = new RuntypeClient({
4
  apiKey: process.env.RUNTYPE_API_KEY,
5
})
6
7
const result = await new FlowBuilder()
8
  .createFlow({ name: 'Agent with tools' })
9
  .prompt({
10
    name: 'Agent',
11
    model: 'gpt-5.4',
12
    userPrompt: 'Help the user with their request',
13
    tools: {
14
      toolIds: ['YOUR_TOOL_ID'],
15
      maxToolCalls: 10,
16
      toolCallStrategy: 'auto',
17
    },
18
  })
19
  .run(client, { streamResponse: true })

1
import os
2
3
from runtype import RuntypeClient
4
5
client = RuntypeClient(api_key=os.environ["RUNTYPE_API_KEY"])
6
7
for event in client.dispatch({
8
    "flow": {
9
        "name": "Agent with tools",
10
        "steps": [{
11
            "type": "prompt",
12
            "config": {
13
                "model": "gpt-5.4",
14
                "userPrompt": "Help the user with their request",
15
                "tools": {
16
                    "toolIds": ["YOUR_TOOL_ID"],
17
                    "maxToolCalls": 10,
18
                    "toolCallStrategy": "auto"
19
                }
20
            }
21
        }]
22
    }
23
}):
24
    print(event)

$
curl https://api.runtype.com/v1/dispatch \
>
  -H "Authorization: Bearer YOUR_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "flow": {
>
      "name": "Agent with tools",
>
      "steps": [{
>
        "type": "prompt",
>
        "config": {
>
          "model": "gpt-5.4",
>
          "userPrompt": "Help the user with their request",
>
          "tools": {
>
            "toolIds": ["YOUR_TOOL_ID"],
>
            "maxToolCalls": 10,
>
            "toolCallStrategy": "auto"
>
          }
>
        }
>
      }]
>
    }
>
  }'

1
const externalTool = {
2
  name: 'get_weather',
3
  description: 'Get the weather for a city',
4
  toolType: 'external',
5
  parametersSchema: {
6
    type: 'object',
7
    properties: {
8
      city: { type: 'string', description: 'City name' },
9
    },
10
    required: ['city'],
11
  },
12
  config: {
13
    url: 'https://api.example.com/weather?city={{city}}',
14
    method: 'GET',
15
    headers: {
16
      Authorization: 'Bearer {{secret:WEATHER_API_KEY}}',
17
    },
18
  },
19
}

1
const customTool = {
2
  name: 'calculate_discount',
3
  description: 'Calculate a discounted price',
4
  toolType: 'custom',
5
  parametersSchema: {
6
    type: 'object',
7
    properties: {
8
      price: { type: 'number' },
9
      discount: { type: 'number' },
10
    },
11
    required: ['price', 'discount'],
12
  },
13
  config: {
14
    code: `
15
      const { price, discount } = parameters;
16
      const discounted = price * (1 - discount / 100);
17
      return {
18
        original: price,
19
        discounted: discounted.toFixed(2),
20
        savings: (price - discounted).toFixed(2),
21
      };
22
    `,
23
    timeout: 5000,
24
    allowedApis: [],
25
  },
26
}

1
tools: {
2
  toolIds: [
3
    'builtin:gpt-image-2',
4
    'builtin:openai_web_search',
5
  ],
6
}

1
tools: {
2
  toolIds: [
3
    'mcp:YOUR_SERVER_NAME:YOUR_TOOL_NAME',
4
  ],
5
}

1
tools: {
2
  mcpServers: [
3
    {
4
      id: 'YOUR_MCP_SERVER_ID',
5
      url: 'https://example.com/mcp',
6
      auth: {
7
        type: 'bearer',
8
        token: process.env.MCP_TOKEN,
9
      },
10
      timeout: 30000,
11
    },
12
  ],
13
}

1
const runtimeTool = {
2
  name: 'fetch_user',
3
  description: 'Fetch a user by ID',
4
  toolType: 'external',
5
  parametersSchema: {
6
    type: 'object',
7
    properties: {
8
      userId: { type: 'string' },
9
    },
10
    required: ['userId'],
11
  },
12
  config: {
13
    url: 'https://api.example.com/users/{{userId}}',
14
    method: 'GET',
15
  },
16
}
17
18
const tools = {
19
  runtimeTools: [runtimeTool],
20
}

1
tools: {
2
  toolIds: [
3
    'YOUR_TOOL_ID',
4
    'builtin:gpt-image-2',
5
    'mcp:YOUR_SERVER_NAME:YOUR_TOOL_NAME',
6
  ],
7
  runtimeTools: [
8
    {
9
      name: 'fetch_user',
10
      description: 'Fetch a user by ID',
11
      toolType: 'external',
12
      parametersSchema: {
13
        type: 'object',
14
        properties: {
15
          userId: { type: 'string' },
16
        },
17
        required: ['userId'],
18
      },
19
      config: {
20
        url: 'https://api.example.com/users/{{userId}}',
21
        method: 'GET',
22
      },
23
    },
24
  ],
25
  mcpServers: [
26
    {
27
      id: 'YOUR_MCP_SERVER_ID',
28
      url: 'https://example.com/mcp',
29
      auth: {
30
        type: 'bearer',
31
        token: process.env.MCP_TOKEN,
32
      },
33
      timeout: 30000,
34
    },
35
  ],
36
  maxToolCalls: 15,
37
  toolCallStrategy: 'auto',
38
}

1
headers: {
2
  Authorization: 'Bearer {{secret:WEATHER_API_KEY}}',
3
}