Tool Parameters Tab of an Integration

This documentation is valid for:

When you create or edit a Private Integration, three tabs are shown: Security Scheme, Integration Parameters, and Tool Parameters.

For a Public Integration, only two tabs are shown: Integration Parameters and Tool Parameters.

The Tool Parameters tab defines the inputs that a specific Tool within the Integration requires to run correctly. These values are used when the Tool makes external API requests or processes data during execution.

If a Tool has no parameters defined yet, the interface will display a collapsed panel header with the Tool name and description, but no parameter rows. To add a new parameter, click on + Add new parameter inside the expanded Tool panel. A new row appears where you can enter the parameter details.

To add a parameter, click on + Add new parameter. Then complete the following fields:

Key

Identifier used to reference the parameter. It must match the exact name of the parameter as defined in the OpenAPI specification. For example, if the endpoint includes parameters such as "queryText" and "provider", those same names must be used as keys in the tool configuration to ensure the values are correctly mapped at runtime.

Description

Brief explanation of the parameter’s role.

Type

Defines the kind of parameter you are configuring. You can choose from the following:

Application:

Used to pass dynamic values at runtime, typically based on user input or the specific execution context. For example, a Tool that sends an email may receive the recipient address and message content as application parameters. These values are resolved by the LLM during execution and are often sent as query parameters, particularly in GET requests.
This type is especially useful when the OpenAPI description is not detailed enough for the LLM to infer what values are expected, or when additional guidance is needed to ensure the tool behaves correctly during execution.
Config:

Used to define fixed values, such as API tokens, credentials, URLs, or email addresses, among others, to be configured per project. The specific values depend on what the Tool accepts. These values are usually sent in headers and remain static during execution. This is the only type of parameter that you can view and modify directly when you select the Tool from an AI and Tools Tab of an Agent. If the value contains sensitive information (for example, tokens or credentials), configure it as a Secret instead of entering it in plain text.
Context:

Allows the Tool to automatically retrieve values from the runtime session, such as user, project, or organization information. These parameters do not require manual configuration, since their values are dynamically resolved during execution.
Some commonly used context keys include:
- API_TOKEN: Retrieves the token associated with the current project. If no token is found, the system uses a default value.
- USER_ID, USER_NAME, USER_EMAIL: Provides information about the user who initiated the request.
- ORGANIZATION_ID, PROJECT_ID, ORGANIZATION_NAME, PROJECT_NAME: Identifies the organization and project context.

If the key matches the context variable name expected by the tool, the Value field can be left blank. The list of available context keys is predefined in The Lab and can be queried through the API when needed.

In addition, the Secret setting has no effect on the context parameters and can be left unselected.

Value

Sets the default or fixed value for the parameter.

For Config parameters, this field is required and determines the static value the tool will use. You can enter a fixed literal value (e.g., a base URL or timeout) or reference a Secret by specifying its name. For example, if you enter "My Secret API Key" in this field, the Tool will look for a Secret with that exact name to retrieve the actual value securely.
For Context parameters, this field is optional and only needed if the key and context variable differ.
For Application parameters, this field is typically left blank, since values are provided dynamically at runtime.