Options

Options for @kubb/plugin-mcp, which generates an MCP server where each OpenAPI operation becomes a typed tool handler.

output ​

Where the generated MCP handler files are written and how they are exported.

output.path ​

Folder where the plugin writes its files, resolved against the global output.path on defineConfig and defaulting to mcp. Give it an extensionless directory name — path naming a single file (with output.mode: 'file', explicit or inferred from an extension) is rejected, since plugin-mcp always writes server.ts and .mcp.json alongside the per-operation handlers.

output.mode ​

How the plugin consolidates its generated code. Only 'directory' is supported: one file per operation is written under output.path, next to the fixed server.ts and .mcp.json files. output.mode: 'file' fails the build with a setup error, since a single file has nowhere to put those extra files — leave mode unset (an extensionless output.path, the default mcp, resolves to 'directory') or set it to 'directory' explicitly.

output.barrel ​

Toggle the export style and depth to see the generated barrels.

Controls how the generated index.ts (barrel) re-exports the output. Accepts { type: 'named' } or { type: 'all' }, optionally with nested: true (for example { type: 'named', nested: true }) to write an index.ts in every subdirectory, or false to skip the barrel entirely. Kubb reads the plugin's own output.barrel first, falls back to config.output.barrel on defineConfig, and finally to false. Every generator plugin ships a default output that sets barrel: { type: 'named' }, but passing your own output replaces that object wholesale, so repeat barrel whenever you set output yourself.

output.banner ​

Text added to the top of every generated file, such as a license header or @ts-nocheck directive. Pass a string, or a function (meta: BannerMeta) => string that receives the document info (title, description, version, baseURL) and per-file context (filePath, baseName, isBarrel, isAggregation), so a directive can skip barrel files.

output.footer ​

Text added to the bottom of every generated file (string or (meta: BannerMeta) => string), like banner but for closing comments. Pair banner: '/* eslint-disable */' with footer: '/* eslint-enable */' to scope a lint disable to the generated file.

group ​

Switch the mode to see where these operations land on disk.

Splits generated files into subfolders by the operation's tag or URL path, each under {output.path}/{groupName}/. Without group, every file lands directly in output.path. It applies only to output.mode: 'directory'.

group.type ​

Property used to assign each operation to a group ('tag' | 'path'), required whenever group is set. An operation with no tag goes in the default group.

• 'tag' uses the operation's first tag.
• 'path' uses the first URL segment, such as pet for /pet/{petId}.

group.name ​

Function that turns a group key into the subdirectory name under output.path. It defaults to the camelCased tag for tag groups and the first URL segment as-is for path groups. The server.ts and .mcp.json files keep their fixed names at the root of output.path.

client ​

Selects which registered client plugin the handlers call, 'fetch' for @kubb/plugin-fetch or 'axios' for @kubb/plugin-axios. Each handler calls that client's generated <op> for the operation, passing one grouped { path, query, headers, body } object. A lone registered client plugin is auto-detected, so set this only to disambiguate when both are registered, and transport options such as baseURL live on the client plugin itself.

Generated handlers follow the client plugin's returnType option:

• Under returnType: 'full' (default), handlers read the success body from res.data.
• Under returnType: 'data', handlers use the resolved call result directly as the tool response body.
• Handlers always pass throwOnError: true so non-2xx responses throw and surface as tool errors, regardless of client-level throwOnErrorDefault settings.

include ​

Generates only the operations and schemas that match at least one entry, and skips the rest. Each entry filters by tag, operationId, path, method, contentType, or schemaName, with a pattern that can be a string or a RegExp, both matched as a regular expression against the value. A string pattern is compiled with new RegExp(pattern), so it is not an exact match: pattern: 'pet' also matches 'petType' or 'superpet'.

export type Include = {
  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType' | 'schemaName'
  pattern: string | RegExp
}

exclude ​

Skips any operation or schema that matches at least one entry, the opposite of include. Entries use the same type and pattern fields as include, and when both options match an item, exclude wins.

When operations are excluded on a client plugin (@kubb/plugin-fetch or @kubb/plugin-axios), dependent plugins (@kubb/plugin-react-query, @kubb/plugin-vue-query, @kubb/plugin-swr, @kubb/plugin-mcp) skip generating hooks or handlers for those operations automatically, without requiring duplicate exclude configurations.

override ​

Applies different plugin options to operations that match a pattern. Each entry takes the same type and pattern as include, plus an options object that accepts any plugin option except override, so rules cannot nest. The first matching entry merges onto the plugin defaults, and later entries do not stack.

export type Override = {
  type: 'tag' | 'operationId' | 'path' | 'method' | 'contentType' | 'schemaName'
  pattern: string | RegExp
  options: Omit<Partial<Options>, 'override'>
}

When options such as returnType, output, or group are overridden on a client plugin (@kubb/plugin-fetch or @kubb/plugin-axios), dependent plugins (@kubb/plugin-react-query, @kubb/plugin-vue-query, @kubb/plugin-swr, @kubb/plugin-mcp) resolve and follow those per-operation options automatically.

resolver ​

A partial patch changes how the plugin names generated files and symbols. Override only the members you want, and anything you omit keeps resolverMcp. See Override a resolver for the this context and how a patch layers over the default.

type ResolverMcpPatch = {
  name?(name: string): string
  file?: {
    baseName?(params: { name: string; extname: string }): string
    path?(params: { baseName: string; output: Output }): string
  }
  handler?: {
    name?(node: OperationNode): string     // → 'showPetByIdHandler'
  }
}

macros ​

Rewrites AST nodes before they are printed, without forking the generator. Each macro callback (such as schema or operation) receives the node and a context object, and returns a replacement or undefined to leave it as is. Omitted callbacks keep their defaults, and macros run in order, so a later one sees the output of an earlier one.