Tool-Instance Level Storage

This storage is primarily used for persisting authentication tokens per tool instance, allowing them to be shared across all users. To interact with the storage, we provide the following functions within the Server-Side variable runtime environment under the this scope:

Write information to the Storage

CODE

this.toolInstanceStorage.write("<NAME>", <VALUE>, <EXPIRATION TIMESTAMP IN MILLISECONDS>);

Placeholder

Description

Type

Mandatory

Example

<NAME>

This defines the key under which the information should be stored and accessed in the storage.

String

“client_id”

<VALUE>

This defines the value that should be stored in the storage under the given key. There are no limitations on the type.

Any

“123abcd123.11111111”

<EXPIRATION TIMESTAMP>

This defines the expiration timestamp in milliseconds, determining when the information in the storage should be automatically deleted/removed by our clean-up process.

String

Number

JSON

Array

1740555149453

Full Example (Server-Side Variable):

CODE

async function() {
    // Retrieve OAUTH-Token Logic
    ...
    this.toolInstanceStorage.write(
        "auth_token",
        access_token, 
        Date.now() + 86400000
    );
    return access_token;
}

Read information from the Storage

CODE

this.toolInstanceStorage.read("<NAME>");

Placeholder	Description	Type	Mandatory	Example
`<NAME>`	This defines the key under which the information should be stored and accessed in the storage.	String		“client_id”

Full Example (Server-Side Variable):

CODE

async function() {
    // Retrieve OAUTH-Token Logic
    ...
    const access_token = this.toolInstanceStorage.read("auth_token");
    return access_token|| "";
}

Delete information from the Storage

CODE

this.toolInstanceStorage.delete("<NAME>");

Placeholder	Description	Type	Mandatory	Example
`<NAME>`	This defines the key under which the information should be stored and accessed in the storage.	String		“client_id”

Full Example (Server-Side Variable):

CODE

async function() {
    this.toolInstanceStorage.delete("auth_token");
    return "";
}