Skip to main content

Interface: RegisterOpenApiToolsArgs

Defined in: registerOpenApiTools.ts:22

Properties

callApi

callApi: (request) => unknown

Defined in: registerOpenApiTools.ts:34

Performs the HTTP request for a resolved tool call and returns the raw response data. This package builds the method/url/body; the caller owns how the request is executed — base URL, auth headers, fetch impl, etc.

Parameters

ParameterType
requestResolvedRequest

Returns

unknown


options?

optional options?: OpenApiToToolsOptions

Defined in: registerOpenApiTools.ts:28

Tuning options forwarded to openApiToToolDefinitions.


server

server: McpServer

Defined in: registerOpenApiTools.ts:24

The MCP server the generated tools are registered on.


spec

spec: OpenApiSpec | OpenApiSpec[]

Defined in: registerOpenApiTools.ts:26

One or more OpenAPI documents to derive tools from.


toText?

optional toText?: (data) => string

Defined in: registerOpenApiTools.ts:39

Serialises the raw API data into the MCP tool's text payload.

Parameters

ParameterType
dataunknown

Returns

string

Default

(data) => JSON.stringify(data, null, 2)