ai-sdk-harness
API reference

ai-sdk-harness-plugins

The shape of a plugin, and the options of withPlugins, generated from the source.

definePlugin(plugin)

Checks a plugin, written in code or as JSON, and returns it as it is. Throws InvalidPluginError, whose issues list every mistake by field.

Prop

Type

PluginCommand

Prop

Type

PluginHook

Prop

Type

PluginSubagent

Prop

Type

PluginRule

Prop

Type

PluginFile

Prop

Type

withPlugins(settings, plugins, options)

Returns the HarnessAgent settings with the plugins applied.

Prop

Type

expandCommand(text, plugins)

The prompt text stands for when it calls a command of the plugins, or undefined.

Prop

Type

createCatalog(sources)

A marketplace: plugins of code, and plugins and items kept as data.

Prop

Type

Prop

Type

CatalogEntry

Prop

Type

CatalogItemDescription

What describe() gives for each item: safe to send to a browser.

Prop

Type

PluginDescription

What describe() gives for each plugin: safe to send to a browser.

Prop

Type

mcpToolsPlugin(options)

A plugin of the tools of an MCP server your server is connected to.

Prop

Type

resolvePlugins(plugins, options)

Resolves plugins that hold registered tools, secrets or MCP servers your server connects to.

Prop

Type

ResolveOptions

What catalog.resolve() and resolvePlugins() take at runtime.

Prop

Type

Prop

Type

Item

An item on its own: a tool, a skill, a command, a hook, a subagent or an MCP server, with its kind.

Prop

Type

ToolDefinition

A tool written as configuration: a request your server makes, a command run in the sandbox, or a reference to a tool your application implements.

Prop

Type

On this page