Documentation
Basics
Agentic Flows
Integrations
Tools Provider
Prompt Preprocessor
Generators
Custom Configuration
Publishing a Plugin
Text Embedding
Tokenization
API Reference
Model Info
Basics
Agentic Flows
Integrations
Tools Provider
Prompt Preprocessor
Generators
Custom Configuration
Publishing a Plugin
Text Embedding
Tokenization
API Reference
Model Info
Integrations
Introduction
Add custom configurations to LM Studio plugins using TypeScript
Plugin support is currently in private beta. Join the beta here.
LM Studio plugins support custom configurations. That is, you can define a configuration schema and LM Studio will present a UI to the user so they can configure your plugin without having to edit any code.
There are two types of configurations:
You can define configurations in TypeScript using the createConfigSchematics
function from the @lmstudio/sdk
package. This function allows you to define fields with various types and options.
Supported types include:
string
: A text input field.numeric
: A number input field with optional validation and slider UI.boolean
: A checkbox or toggle input field.stringArray
: An array of string values with configurable constraints.select
: A dropdown selection field with predefined options.See the Defining New Fields section for more details on how to define these fields.
The following are some plugins that make use of custom configurations
Gives the LLM tools to search and read Wikipedia articles.
lmstudio/openai-compat-endpoint
Use any OpenAI-compatible API in LM Studio.
This page's source is available on GitHub