> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create run input request

> Create a form input request for a run, as REST POST /runs/{run_id}/input-requests.

export const McpToolCall = ({tool, initialArguments = {}, requiresConfirmation = false}) => {
  const validateCall = function validateReferenceToolCall(token, text, requiresConfirmation, confirmed) {
    if (!token.trim()) return {
      error: "Paste a bearer token first."
    };
    let value;
    try {
      value = JSON.parse(text.trim() || "{}");
    } catch {
      return {
        error: "Arguments must be valid JSON."
      };
    }
    if (!value || typeof value !== "object" || Array.isArray(value)) return {
      error: "Arguments must be a JSON object."
    };
    if (requiresConfirmation && !confirmed) return {
      error: "Confirm the tool call before running it."
    };
    return {
      arguments: value
    };
  };
  const endpoint = "https://api.veryfront.com/mcp";
  const tokenStorageKey = 'veryfront.docs.mcpBearerToken';
  const escapeHtml = value => value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
  const highlightJson = value => {
    const escaped = escapeHtml(value);
    return escaped.replace(/("(?:\\u[a-fA-F0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\btrue\b|\bfalse\b|\bnull\b|-?\d+(?:\.\d+)?(?:[eE][+\-]?\d+)?)/g, match => {
      let color = '#f3f4f6';
      if (match.endsWith(':')) {
        color = '#7dd3fc';
      } else if (match.startsWith('"')) {
        color = '#86efac';
      } else if ((/true|false/).test(match)) {
        color = '#c4b5fd';
      } else if ((/null/).test(match)) {
        color = '#fcd34d';
      } else {
        color = '#67e8f9';
      }
      return `<span style="color: ${color}">${match}</span>`;
    });
  };
  const expandJsonStrings = value => {
    if (typeof value === 'string') {
      const trimmed = value.trim();
      if (trimmed.startsWith('{') && trimmed.endsWith('}') || trimmed.startsWith('[') && trimmed.endsWith(']')) {
        try {
          return expandJsonStrings(JSON.parse(trimmed));
        } catch {}
      }
      return value;
    }
    if (Array.isArray(value)) {
      return value.map(expandJsonStrings);
    }
    if (value && typeof value === 'object') {
      return Object.fromEntries(Object.entries(value).map(([key, nestedValue]) => [key, expandJsonStrings(nestedValue)]));
    }
    return value;
  };
  const formatJson = value => {
    try {
      return JSON.stringify(expandJsonStrings(value), null, 2);
    } catch {
      return String(value);
    }
  };
  const formatResponseText = text => {
    const trimmed = text.trim();
    if (!trimmed) return 'No response body.';
    try {
      return formatJson(JSON.parse(trimmed));
    } catch {}
    const ssePayloads = trimmed.split(/\n\n+/).flatMap(chunk => chunk.split('\n').filter(line => line.startsWith('data:')).map(line => line.slice(5).trim()).filter(Boolean));
    for (let index = ssePayloads.length - 1; index >= 0; index -= 1) {
      try {
        return formatJson(JSON.parse(ssePayloads[index]));
      } catch {}
    }
    return trimmed;
  };
  const readStoredToken = () => {
    if (typeof window === 'undefined') return '';
    try {
      return window.sessionStorage.getItem(tokenStorageKey) || '';
    } catch {
      return '';
    }
  };
  const writeStoredToken = value => {
    if (typeof window === 'undefined') return;
    try {
      if (value) {
        window.sessionStorage.setItem(tokenStorageKey, value);
      } else {
        window.sessionStorage.removeItem(tokenStorageKey);
      }
    } catch {}
  };
  const [token, setToken] = useState(readStoredToken);
  const [argumentText, setArgumentText] = useState(formatJson(initialArguments));
  const [status, setStatus] = useState('Ready');
  const [response, setResponse] = useState('No response yet.');
  const [copied, setCopied] = useState(false);
  const [confirmed, setConfirmed] = useState(false);
  const callTool = async () => {
    const validation = validateCall(token, argumentText, requiresConfirmation, confirmed);
    if (('error' in validation)) {
      setStatus(validation.error);
      return;
    }
    const parsedArguments = validation.arguments;
    setConfirmed(false);
    const body = {
      jsonrpc: '2.0',
      id: Date.now(),
      method: 'tools/call',
      params: {
        name: tool,
        arguments: parsedArguments
      }
    };
    setStatus('Calling tool...');
    setResponse(formatJson(body));
    try {
      const result = await fetch(endpoint, {
        method: 'POST',
        headers: {
          accept: 'application/json, text/event-stream',
          'content-type': 'application/json',
          authorization: `Bearer ${token.trim()}`,
          'x-veryfront-origin': 'docs-mcp-tool-page'
        },
        body: JSON.stringify(body)
      });
      const text = await result.text();
      setStatus(result.ok ? 'Response received.' : `Request failed with HTTP ${result.status}.`);
      setResponse(formatResponseText(text));
    } catch (error) {
      setStatus('Request failed.');
      setResponse(error instanceof Error ? error.message : String(error));
    }
  };
  const copyResponse = async () => {
    try {
      await navigator.clipboard.writeText(response);
      setCopied(true);
      setTimeout(() => setCopied(false), 1500);
    } catch {
      setStatus('Copy failed.');
    }
  };
  return <details className="api-try-operation not-prose">
    <summary>Try this tool</summary>
    <p>Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.</p>
    <div className="api-request-playground not-prose my-6 rounded-xl border border-gray-200 bg-white p-4 dark:border-gray-800 dark:bg-gray-950">
      <div className="mb-4">
        <div className="text-sm font-semibold text-gray-900 dark:text-gray-100">MCP tool call</div>
        <div className="mt-1 text-sm text-gray-600 dark:text-gray-400">
          Call <code>{tool}</code> against the Veryfront MCP endpoint.
        </div>
      </div>

      <label className="mb-2 block text-sm font-medium text-gray-900 dark:text-gray-100" htmlFor={`${tool}-token`}>
        Bearer token or API key
      </label>
      <input id={`${tool}-token`} className="mb-4 w-full rounded-md border border-gray-300 bg-white px-3 py-2 text-sm text-gray-900 dark:border-gray-700 dark:bg-gray-900 dark:text-gray-100" type="password" value={token} onChange={event => {
    const value = event.target.value;
    setToken(value);
    setConfirmed(false);
    writeStoredToken(value);
  }} placeholder="Paste API key or JWT" />

      <label className="mb-2 block text-sm font-medium text-gray-900 dark:text-gray-100" htmlFor={`${tool}-arguments`}>
        Arguments (JSON)
      </label>
      <textarea id={`${tool}-arguments`} className="mb-4 min-h-40 w-full rounded-md border border-gray-300 bg-white px-3 py-2 font-mono text-sm text-gray-900 dark:border-gray-700 dark:bg-gray-900 dark:text-gray-100" value={argumentText} onChange={event => {
    setArgumentText(event.target.value);
    setConfirmed(false);
  }} spellCheck={false} />

      {requiresConfirmation && <label className="api-request-confirmation mb-4 flex items-start gap-2 text-sm">
        <input type="checkbox" checked={confirmed} onChange={event => setConfirmed(event.target.checked)} />
        <span>{tool === 'veryfront__set_project_inference_policy' ? 'Replace the project inference policy with these arguments. Omitted constraints will be removed.' : 'Run this tool with these arguments.'}</span>
      </label>}
      <button disabled={status === 'Calling tool...' || requiresConfirmation && !confirmed} className="disabled:opacity-50 disabled:cursor-not-allowed rounded-md bg-gray-900 px-3 py-2 text-sm font-medium text-white hover:bg-gray-700 dark:bg-gray-100 dark:text-gray-950 dark:hover:bg-gray-300" type="button" onClick={callTool}>
        Run tool
      </button>

      <div className="mt-4 text-sm font-medium text-gray-900 dark:text-gray-100">{status}</div>
      <div className="mt-3 overflow-hidden rounded-md border border-gray-300 dark:border-gray-700">
        <div className="flex items-center justify-between bg-gray-100 px-3 py-2 text-sm font-medium text-gray-900 dark:bg-gray-900 dark:text-gray-100">
          <span>Output JSON</span>
          <button className="rounded border border-gray-300 bg-white px-2 py-1 text-xs text-gray-900 hover:bg-gray-50 dark:border-gray-700 dark:bg-gray-950 dark:text-gray-100 dark:hover:bg-gray-800" type="button" onClick={copyResponse}>
            {copied ? 'Copied' : 'Copy'}
          </button>
        </div>
      <pre className="max-h-96 overflow-auto whitespace-pre-wrap break-words bg-gray-950 p-4 text-sm text-gray-100">
        <code dangerouslySetInnerHTML={{
    __html: highlightJson(response)
  }} />
      </pre>
      </div>
    </div>
    </details>;
};

<div className="api-operation-signature">
  `veryfront__create_run_input_request`
</div>

Requires editor access to the resource that owns the run, as other run mutations do.

Returns resource-already-exists when an open request already exists for the same run and tool call.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Can change resources.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `tool_call_id` | `string` | Yes | Tool call identifier that links this request to a prior tool invocation. Minimum length: `1`. Maximum length: `255`. |
| `kind` | `string` | No | Provide the kind. Default: `"form"`. Values: `"form"`. |
| `requested_responder_type` | `string` | Yes | Provide the requested responder type. Values: `"human"`, `"agent"`, `"system"`. |
| `title` | `string` | Yes | Short human-readable title for the record. Minimum length: `1`. Maximum length: `1000`. |
| `description` | `string` | No | Human-readable description that clarifies the request. Minimum length: `1`. Maximum length: `20000`. |
| `fields` | `object[]` | Yes | Fields that define the structured input request. |
| `recommendations` | `object` | No | Suggested values or defaults that help complete the request. |
| `expires_at` | `string` | No | Provide the expires at. Format: `date-time`. |
| `metadata` | `object` | No | Additional structured metadata for the request. |
| `run_id` | `string` | Yes | Public run id, as returned by REST GET /runs/\{`run_id`}. Minimum length: `1`. Maximum length: `255`. |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](/docs/cloud/getting-started/connect-mcp).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_run_input_request",
    "arguments": {
      "tool_call_id": "example",
      "requested_responder_type": "human",
      "title": "example",
      "fields": [
        {
          "name": "example",
          "type": "example"
        }
      ],
      "run_id": "example"
    }
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for the returned record. Format: `uuid`. |
| `conversation_id` | `string or null` | Yes | Conversation identifier associated with this result. |
| `run_id` | `string` | Yes | Run identifier associated with this result. |
| `tool_call_id` | `string` | Yes | Tool call identifier associated with this result. |
| `kind` | `string` | Yes | Value: `"form"`. |
| `status` | `string` | Yes | Lifecycle status for the returned record. Values: `"open"`, `"submitted"`, `"cancelled"`, `"expired"`. |
| `requested_responder_type` | `string` | Yes | Values: `"human"`, `"agent"`, `"system"`. |
| `title` | `string` | Yes | Short human-readable title returned by the tool. |
| `description` | `string or null` | Yes | Human-readable description returned by the tool. |
| `fields` | `object[]` | Yes | Fields returned for the structured input request. |
| `recommendations` | `object or null` | Yes | Suggested values or defaults returned by the tool. |
| `metadata` | `object or null` | Yes | Additional structured metadata returned by the tool. |
| `created_at` | `string` | Yes | Creation timestamp in ISO 8601 format. |
| `expires_at` | `string or null` | Yes | |
| `submitted_at` | `string or null` | Yes | Submission timestamp in ISO 8601 format. |
| `cancelled_at` | `string or null` | Yes | |
| `expired_at` | `string or null` | Yes | |
| `latest_response` | `object or null` | No | |

## Full schemas

<CodeGroup>
  ```json title="input-schema.json" theme={null}
  {
    "type": "object",
    "properties": {
      "tool_call_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "description": "Tool call identifier that links this request to a prior tool invocation."
      },
      "kind": {
        "type": "string",
        "enum": [
          "form"
        ],
        "description": "Provide the kind.",
        "default": "form"
      },
      "requested_responder_type": {
        "type": "string",
        "enum": [
          "human",
          "agent",
          "system"
        ],
        "description": "Provide the requested responder type."
      },
      "title": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1000,
        "description": "Short human-readable title for the record."
      },
      "description": {
        "type": "string",
        "minLength": 1,
        "maxLength": 20000,
        "description": "Human-readable description that clarifies the request."
      },
      "fields": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255,
              "description": "Human-readable name for the target record."
            },
            "type": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64,
              "description": "Provide the type."
            },
            "label": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1000,
              "description": "Provide the label."
            },
            "required": {
              "type": "boolean",
              "description": "Provide the required."
            },
            "options": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": {
                  "description": "Additional structured values supplied to the tool."
                },
                "description": "One option item supplied to the tool."
              },
              "description": "Provide the options."
            }
          },
          "required": [
            "name",
            "type"
          ],
          "additionalProperties": true,
          "description": "One field item supplied to the tool."
        },
        "minItems": 1,
        "maxItems": 100,
        "description": "Fields that define the structured input request."
      },
      "recommendations": {
        "type": "object",
        "additionalProperties": {
          "description": "Additional structured values supplied to the tool."
        },
        "description": "Suggested values or defaults that help complete the request."
      },
      "expires_at": {
        "type": "string",
        "format": "date-time",
        "description": "Provide the expires at."
      },
      "metadata": {
        "type": "object",
        "additionalProperties": {
          "description": "Additional structured values supplied to the tool."
        },
        "description": "Additional structured metadata for the request."
      },
      "run_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "description": "Public run id, as returned by REST GET /runs/{run_id}."
      }
    },
    "required": [
      "tool_call_id",
      "requested_responder_type",
      "title",
      "fields",
      "run_id"
    ],
    "additionalProperties": false,
    "description": "Arguments for the create_run_input_request tool.",
    "$schema": "http://json-schema.org/draft-07/schema#"
  }
  ```

  ```json title="output-schema.json" theme={null}
  {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid",
        "description": "Unique identifier for the returned record."
      },
      "conversation_id": {
        "anyOf": [
          {
            "$ref": "#/properties/id",
            "description": "Conversation identifier associated with this result."
          },
          {
            "type": "null",
            "description": "Conversation identifier associated with this result."
          }
        ],
        "description": "Conversation identifier associated with this result."
      },
      "run_id": {
        "type": "string",
        "description": "Run identifier associated with this result."
      },
      "tool_call_id": {
        "type": "string",
        "description": "Tool call identifier associated with this result."
      },
      "kind": {
        "type": "string",
        "const": "form"
      },
      "status": {
        "type": "string",
        "enum": [
          "open",
          "submitted",
          "cancelled",
          "expired"
        ],
        "description": "Lifecycle status for the returned record."
      },
      "requested_responder_type": {
        "type": "string",
        "enum": [
          "human",
          "agent",
          "system"
        ]
      },
      "title": {
        "type": "string",
        "description": "Short human-readable title returned by the tool."
      },
      "description": {
        "type": [
          "string",
          "null"
        ],
        "description": "Human-readable description returned by the tool."
      },
      "fields": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "description": "Fields returned for the structured input request."
      },
      "recommendations": {
        "anyOf": [
          {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Suggested values or defaults returned by the tool."
          },
          {
            "type": "null",
            "description": "Suggested values or defaults returned by the tool."
          }
        ],
        "description": "Suggested values or defaults returned by the tool."
      },
      "metadata": {
        "anyOf": [
          {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Additional structured metadata returned by the tool."
          },
          {
            "type": "null",
            "description": "Additional structured metadata returned by the tool."
          }
        ],
        "description": "Additional structured metadata returned by the tool."
      },
      "created_at": {
        "type": "string",
        "description": "Creation timestamp in ISO 8601 format."
      },
      "expires_at": {
        "type": [
          "string",
          "null"
        ]
      },
      "submitted_at": {
        "type": [
          "string",
          "null"
        ],
        "description": "Submission timestamp in ISO 8601 format."
      },
      "cancelled_at": {
        "type": [
          "string",
          "null"
        ]
      },
      "expired_at": {
        "type": [
          "string",
          "null"
        ]
      },
      "latest_response": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/properties/id",
                "description": "Unique identifier for the returned record."
              },
              "input_request_id": {
                "$ref": "#/properties/id",
                "description": "The input request id returned by the tool."
              },
              "conversation_id": {
                "anyOf": [
                  {
                    "$ref": "#/properties/id",
                    "description": "Conversation identifier associated with this result."
                  },
                  {
                    "type": "null",
                    "description": "Conversation identifier associated with this result."
                  }
                ],
                "description": "Conversation identifier associated with this result."
              },
              "run_id": {
                "type": "string",
                "description": "Run identifier associated with this result."
              },
              "actor_type": {
                "type": "string",
                "enum": [
                  "human",
                  "agent",
                  "system",
                  "integration"
                ],
                "description": "Type of actor associated with this result."
              },
              "actor_id": {
                "type": "string",
                "description": "Identifier for the actor associated with this result."
              },
              "values": {
                "type": "object",
                "additionalProperties": {
                  "type": [
                    "string",
                    "boolean",
                    "number",
                    "null"
                  ],
                  "description": "Additional structured values supplied to the tool."
                },
                "description": "Structured values submitted to the tool."
              },
              "created_at": {
                "type": "string",
                "description": "Creation timestamp in ISO 8601 format."
              }
            },
            "required": [
              "id",
              "input_request_id",
              "conversation_id",
              "run_id",
              "actor_type",
              "actor_id",
              "values",
              "created_at"
            ],
            "additionalProperties": false,
            "description": "Structured latest response details associated with this tool result."
          },
          {
            "type": "null",
            "description": "The latest response returned by the tool."
          }
        ]
      }
    },
    "required": [
      "id",
      "conversation_id",
      "run_id",
      "tool_call_id",
      "kind",
      "status",
      "requested_responder_type",
      "title",
      "description",
      "fields",
      "recommendations",
      "metadata",
      "created_at",
      "expires_at",
      "submitted_at",
      "cancelled_at",
      "expired_at"
    ],
    "additionalProperties": false,
    "description": "Structured result returned by the create_run_input_request tool.",
    "$schema": "http://json-schema.org/draft-07/schema#"
  }
  ```
</CodeGroup>

<McpToolCall
  tool="veryfront__create_run_input_request"
  requiresConfirmation={true}
  initialArguments={{
"tool_call_id": "example",
"requested_responder_type": "human",
"title": "example",
"fields": [
  {
    "name": "example",
    "type": "example"
  }
],
"run_id": "example"
}}
/>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.