Documentation

lmstudio icon
App
Python SDK
TS/JS SDK
CLI Reference

Integrations

Accessing Configuration

Feature In Beta

Plugin support is currently in private beta. Join the beta here.

You can access the configuration using the method ctl.getPluginConfig(configSchematics) and ctl.getGlobalConfig(globalConfigSchematics) respectively.

For example, here is how to access the config within the promptPreprocessor:

import { type PreprocessorController, type ChatMessage } from "@lmstudio/sdk";
import { configSchematics } from "./config";

export async function preprocess(ctl: PreprocessorController, userMessage: ChatMessage) {
  const pluginConfig = ctl.getPluginConfig(configSchematics);
  const myCustomField = pluginConfig.get("myCustomField");

  const globalPluginConfig = ctl.getGlobalPluginConfig(configSchematics);
  const globalMyCustomField = globalPluginConfig.get("myCustomField");

  return (
    `${userMessage.getText()},` +
    `myCustomField: ${myCustomField}, ` +
    `globalMyCustomField: ${globalMyCustomField}`
  );
}

This page's source is available on GitHub