Build a TypingMind Plugin

• You can write code in JavaScript (if implemented via JavaScript)

• Basic understand of HTTP requests (if implemented via HTTP Actions)

• You understand the OpenAI Function Calling API

• Plugin Name: to be shown to the user.

• Overview: introduction about the plugin and how to use it. Markdown is supported.

json
{
  "name": "generate_random_number_in_range",
  "description": "Generate a random integer number between number 'a' and number 'b'.",
  "parameters": {
    "type": "object",
    "properties": {
      "a": {
        "type": "number",
        "description": "The number a (the smaller number)"
      },
      "b": {
        "type": "number",
        "description": "The number b (the larger number)"
      }
    },
    "required": [
      "a",
      "b"
    ]
  }
}

json
[
  {
    "name": "searchEngineID",
    "label": "Search Engine ID"
  },
  {
    "name": "searchEngineAPIKey",
    "label": "Search Engine API Key",
    "type": "password"
  },
	{
	  "name": "quality",
	  "label": "Quality",
	  "description": "Optional, default: \"standard\"",
	  "type": "enum",
	  "values": [
	    "standard",
	    "hd"
	  ]
	}
]

• name: This is the identifier the plugin will use to retrieve the user's input.

• label: This is the label displayed to the user to help identify what information should be entered. Try to make this intuitive and relevant to the data you're asking for.

• required (optional): must be a boolean value of true or false , indicate whether the field is required or not. Default false.

• description (optional): Displayed as a small text under the label. Use this to clarify other information related to the field.

• type (optional): This is used to specify the type of data expected from the users. For instance, input type could be password, email, number, enum . By default, if not specified, the type is assumed to be text.

• placeholder (optional): The placeholder text to be shown in the input field.

• values (optional): Only take effect when type is enum, this must be an array of strings of allowed value for the field.

• defaultValue (optional): the default value if not provided by the user

• First parameter (params): The parameter created by the AI assistant everytime your function is created. The object contains multiple key/value pairs that the AI will decide when they execute your function.

• Second parameter (userSettings): If your plugin has a User Settings (discussed in a later section), the key/value pair of the user settings will be passed into this object.

javascript
async function get_search_results(params, userSettings) {
  const { keyword, pages } = params;
  const { searchAPIKey } = userSettings;
  const result = ...  // your code here...
  return result;
}

javascript
function generate_random_number_in_range({a, b}) {
    var min = Math.ceil(a);
    var max = Math.floor(b);
    return Math.floor(Math.random() * (max - min + 1) + min);
}

javascript
function search_images_via_google(params, userSettings) {
  // Your code here
}

• params is an object that contains the runtime parameters passed by the AI or users.

• userSettings is the object that contains all the custom settings configured by the user.

json
[
  {
    "name": "searchEngineID",
    "label": "Search Engine ID"
  },
  {
    "name": "searchEngineAPIKey",
    "label": "Search Engine API Key",
    "type": "password"
  }
]

javascript
function search_images_via_google(params, userSettings) {
  const searchEngineID = userSettings.searchEngineID;
  const searchEngineAPIKey = userSettings.searchEngineAPIKey;

  // Now you can use these values in your code
}

• HTTP Method

• Endpoint URL

• Headers (optional)

• Body (optional)

• Post-Processing (optional)

• the variable {openaikey} is used in the request headers

• the variables {prompt}, {resolution}, {quality} is used the request body.

• JMESPath Transform (docs): Useful to filter a big JSON response to a smaller JSON.

• Handlebars.js Template (docs): Useful to rewrite the JSON response into a different format like Markdown or HTML.

• Give plugin output to the AI

• Render plugin output as markdown

• Render plugin output as interactive HTML

• When using JavaScript implementation, your plugins are run on a sandboxed browser environment. Some JavaScript features may not be available.

• In TypingMind personal version, your plugins can send HTTP requests to external services, however, the destination server must be configured to allow CORS requests from Typing Mind. If CORS requests are not allowed, you will need an intermediate server to process the requests. Some API servers allow CORS requests from everywhere – like Perplexity API, or Open AI – so the intermediate server is not needed in these cases.