transloadit_get_robot_help

Get documentation for Transloadit media processing robots, including summaries, parameter details, and usage examples for video encoding, image manipulation, and file conversion tasks.

Instructions

Returns a robot summary and parameter details.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`robot_name`	No
`robot_names`	No
`detail_level`	No

Implementation Reference

packages/mcp-server/src/server.ts:981-1042 (handler)

The handler for the 'transloadit_get_robot_help' tool. It processes the input (robot_name/robot_names), fetches robot information using 'getRobotHelp', and formats the response.

({ robot_name, robot_names }) => {
  const splitComma = (value: string): string[] =>
    value
      .split(',')
      .map((part) => part.trim())
      .filter(Boolean)

  const prefersSingle =
    typeof robot_name === 'string' && robot_name.trim() !== '' && !robot_name.includes(',')

  const requested =
    robot_names && robot_names.length > 0
      ? robot_names
      : robot_name
        ? splitComma(robot_name)
        : []

  if (requested.length === 0) {
    return buildToolError('mcp_missing_args', 'Provide robot_name or robot_names.')
  }

  const robots: Array<{
    name: string
    summary: string
    required_params: unknown[]
    optional_params: unknown[]
    examples?: unknown[]
  }> = []
  const notFound: string[] = []

  for (const name of requested) {
    if (!isKnownRobot(name)) {
      notFound.push(name)
      continue
    }
    const help = getRobotHelp({
      robotName: name,
      detailLevel: 'full',
    })

    robots.push({
      name: help.name,
      summary: help.summary,
      required_params: help.requiredParams,
      optional_params: help.optionalParams,
      examples: help.examples,
    })
  }

  if (prefersSingle) {
    return buildToolResponse({
      status: 'ok',
      robot: robots[0],
      not_found: notFound.length > 0 ? notFound : undefined,
    })
  }

  return buildToolResponse({
    status: 'ok',
    robots,
    not_found: notFound.length > 0 ? notFound : undefined,
  })

packages/mcp-server/src/server.ts:973-980 (registration)

Registration of the 'transloadit_get_robot_help' tool within the server.

server.registerTool(
  'transloadit_get_robot_help',
  {
    title: 'Get robot parameter help',
    description: 'Returns a robot summary and parameter details.',
    inputSchema: getRobotHelpInputSchema,
    outputSchema: getRobotHelpOutputSchema,
  },

packages/mcp-server/src/server-card.ts:114-125 (schema)

Schema definition for the 'transloadit_get_robot_help' tool.

{
  name: 'transloadit_get_robot_help',
  title: 'Get Robot Help',
  description: 'Returns a robot summary and parameter details.',
  inputSchema: {
    type: 'object',
    additionalProperties: false,
    properties: {
      robot_name: { type: 'string' },
      robot_names: { type: 'array', items: { type: 'string' } },
    },
  },

Transloadit MCP Server